`
wangjie2013
  • 浏览: 173820 次
  • 性别: Icon_minigender_1
  • 来自: 北京
社区版块
存档分类
最新评论

制作java文档说明书

    博客分类:
  • JAVA
阅读更多

 

 

Last modified:2013-04-09 23:39:58

**********************************

 

使用“/** …… */”文档注释进行注释;

在类定义前面常使用注解来说明这个类的功能,版本信息,

@author 作者

@version 版本

用在每个方法前注明方法的参数和返回值。

@param 参数 对参数进行描述;

@return 对返回值进行描述; 

注意:这个类一定要用public修饰。

API(帮助文件)应用程序编程接口文档:

运行指令:javadoc -d <help文档的存储路径> -author -version ArrayTool.java

然后就会在当前目录下生成一个类似java API的文档!

 

分享到:
评论

相关推荐

    Java类说明书制作.docx

    制作Java类说明书通常使用Javadoc工具,这是一个内置在Java开发环境中的命令行工具,用于从源代码中的特定注释生成文档。 首先,我们需要创建一个公共(public)基本类。在Java中,公共类可以被任何其他包中的类...

    JAVA课程设计说明书——班级通讯录.doc

    JAVA课程设计说明书——班级通讯录

    JDK中文手册(JAVA).rar

    JDK中文手册(JAVA),JDK API手册

    Html帮助文档制作方法

    CHM文档不仅支持HTML、ActiveX、Java等多媒体元素,还能嵌入脚本代码(如Java脚本和VB脚本),支持多种图像格式(如JPEG、GIF、PNG)。这种文档格式的优点在于: - **多媒体表现力强**:可以插入GIF动画、声音文件...

    游戏软著申请-使用说明书模板

    使用说明书是详细描述软件功能、操作方法和运行环境的重要文档,对于游戏软著的申请至关重要。本文将根据提供的部分游戏软件使用说明书内容,解析其中涉及的关键知识点。 1. **游戏软件基本信息** - 游戏名称:某...

    java源码包---java 源码 大量 实例

    Java波浪文字制作方法及源代码 1个目标文件 摘要:Java源码,初学实例,波浪文字  Java波浪文字,一个利用Java处理字符的实例,可以设置运动方向参数,显示文本的字符数组,高速文本颜色,显示字体的 FontMetrics对象...

    javaApi开发文档

    Java API 开发文档是Java开发者的重要参考资料,它包含了Java开发工具包(JDK)的所有类库、接口和方法的详细说明。这些文档是理解和使用Java编程语言的关键资源,提供了全面的API规范,帮助开发者了解如何有效地...

    itext说明文档.rar

    这个压缩包"itext说明文档.rar"包含了关于iText的中文帮助文档和C#版本的说明书,为开发者提供了详细的类库说明,使得在进行PDF工具开发时能够更加得心应手。 一、iText概述 iText是一个开源的Java库,主要用于创建...

    毕业设计javajsp网上图书销售系统(jsp+mysql)-qkrp源码含文档工具包

    毕业设计javajsp网上图书销售系统(jsp+mysql)-qkrp源码含文档工具包 页面是jsp,数据库mysql,jdk1.8,开发工具用ecplise、myecplise、sts、idea都可以 本系统以JSP为主要制作工具,实现了用户注册、登陆、图书发布...

    java咖啡机系统产品设计说明书.doc

    设计说明书可能引用了各种技术文档、标准规范、设计模式以及相关的Java编程资料,以确保系统设计的合规性和最佳实践。 1.4 术语 文档中可能会涉及一系列专业术语,如Java API、MVC(模型-视图-控制器)架构、物联网...

    程序文档自动生成工具Doxygen使用手册

    《程序文档自动生成工具Doxygen使用手册》是针对软件开发者设计的一款强大工具,它能够自动为C/C++, Java, C#等编程语言的项目生成详细、结构化的文档。这款工具的核心价值在于它能够显著减轻程序员在编写代码的同时...

    毕业设计javajsp图书销售网站(ssh)-qkrp源码含文档

    毕业设计javajsp图书销售网站(ssh)-qkrp源码含文档 后台是ssh框架,页面是jsp,数据库mysql,jdk1.8,开发工具用ecplise、myecplise、sts、idea都可以 本系统以JSP为主要制作工具,实现了用户注册、登陆、图书发布,...

    java源码包3

    Java波浪文字制作方法及源代码 1个目标文件 摘要:Java源码,初学实例,波浪文字  Java波浪文字,一个利用Java处理字符的实例,可以设置运动方向参数,显示文本的字符数组,高速文本颜色,显示字体的 FontMetrics...

    java源码包2

    Java波浪文字制作方法及源代码 1个目标文件 摘要:Java源码,初学实例,波浪文字  Java波浪文字,一个利用Java处理字符的实例,可以设置运动方向参数,显示文本的字符数组,高速文本颜色,显示字体的 FontMetrics...

    OA系统需求文档

    此外,文档还包含了项目进度安排表、系统设计说明书、测试用例模板和答辩幻灯片的制作要求,确保项目的有序进行。项目组成员需要按照这些模板完成相应的文档,以保证项目的质量和可追溯性。 数据库设计是OA系统的...

    自己的Java编辑器内含源码以及说明书可以自己运行复现.zip

    标题中的“自己的Java编辑器内含源码以及说明书可以自己运行复现.zip”指的是一个包含了一个个人开发的Java编辑器的项目。这个编辑器不仅有实际的可执行程序,还附带了源代码,以便用户可以查看、学习或进行修改。...

    毕业设计javajsp图书借阅管理系统(ssh)-qkrp源码含文档

    毕业设计javajsp图书借阅管理系统(ssh)-qkrp源码含文档 后台是ssh框架,页面是jsp,数据库mysql,jdk1.8,开发工具用ecplise、myecplise、sts、idea都可以 主要完成了图书借阅系统的整体设计与规划、图书数据库的...

    使用jsp和java bean来构建一个网上书店

    此外,提供的文档"使用JSP和Java Bean来构建一个网上书店.doc"可能包含了详细的步骤和示例代码,"说明.txt"可能是关于项目实施的指南或注意事项,而".url"文件可能是相关资源链接,例如教程或示例代码库,这些都可以...

    毕业设计javajsp图书检索借阅(jsp+mysql)-qr源码含文档工具包

    毕业设计javajsp图书检索借阅(jsp+mysql)-qr源码含文档工具包 页面是jsp,数据库mysql,jdk1.8,开发工具用ecplise、myecplise、sts、idea都可以 系统的开发是基于B/S结构,采用JSP程序设计语言及SQLSERVER2005...

    毕业设计javajsp图书借阅管理系统(jsp+mysql)-qrp源码含文档工具包

    毕业设计javajsp图书借阅管理系统(jsp+mysql)-qrp源码含文档工具包 页面是jsp,数据库mysql,jdk1.8,开发工具用ecplise、myecplise、sts、idea都可以 系统的开发是基于B/S结构,采用JSP程序设计语言及SQLSERVER2005...

Global site tag (gtag.js) - Google Analytics