javadoc中文版 1.8.121

javadoc是java的开发公司sun推出的一项技术，能够从用户的程序源码中抽出类、方法、成员等等注释形成一个和源代码配套的API帮助文档，也就是说，只要用户在编写程序时以一套特定的标签作注释，那么在编写完成后，这项技术就能够让你轻松制作一个详细的开发文档。
当然，许多java的编程软件比如Eclipse，JBuilder等IDE都拥有帮助用户生成javadoc的工具，不过许多用户还是比较喜欢直接通过官方的javadoc来进行生成，小编将在这里带给大家这个工具以及使用方法。

注释使用方法

一、文档和文档注释的格式化
生成的文档是 HTML 格式，而这些 HTML 格式的标识符并不是 javadoc 加的，而是我们在写注释的时候写上去的。
比如，需要换行时，不是敲入一个回车符，而是写入br换行符，如果要分段，就应该在段前写入P容器或者P标签。
文档注释的正文并不是直接复制到输出文件 (文档的 HTML 文件)，而是读取每一行后，删掉前导的 * 号及 * 号以前的空格，再输入到文档的。如

2. 文档注释的三部分
先举例如下

第一部分是简述。文档中，对于属性和方法都是先有一个列表，然后才在后面一个一个的详细的说明
简述部分写在一段文档注释的最前面，第一个点号 (.) 之前 (包括点号)。换句话说，就是用第一个点号分隔文档注释，之前是简述，之后是第二部分和第三部分。
第二部分是详细说明部分。该部分对属性或者方法进行详细的说明，在格式上没有什么特殊的要求，可以包含若干个点号。

简述也在其中。这一点要记住了
第三部分是特殊说明部分。这部分包括版本说明、参数说明、返回值说明等。
* @param b true 表示显示，false 表示隐藏
* @return 没有返回值
二、 使用 javadoc 标记
javadoc 标记由"@"及其后所跟的标记类型和专用注释引用组成
javadoc 标记有如下一些：
@author 标明开发该类模块的作者
@version 标明该类模块的版本
@see 参考转向，也就是相关主题
@param 对方法中某参数的说明
@return 对方法返回值的说明
@exception 对方法可能抛出的异常进行说明
@author 作者名
@version 版本号
其中，@author 可以多次使用，以指明多个作者，生成的文档中每个作者之间使用逗号 (,) 隔开。@version 也可以使用多次，只有第一次有效
使用 @param、@return 和 @exception 说明方法
这三个标记都是只用于方法的。@param 描述方法的参数，@return 描述方法的返回值，@exception 描述方法可能抛出的异常。它们的句法如下：
@param 参数名参数说明
@return 返回值说明
@exception 异常类名说明

常用命令

Javadoc命令格式如下：
javadoc [选项] [软件包名称] [源文件]
其中选项有：
-overview <文件> 读取 HTML 文件的概述文档
-public 仅显示公共类和成员
-protected 显示受保护/公共类和成员（默认）
-package 显示软件包/受保护/公共类和成员
-private 显示所有类和成员
-help 显示命令行选项并退出
-doclet <类> 通过替代 doclet 生成输出
-docletpath <路径> 指定查找 doclet 类文件的位置
-sourcepath <路径列表> 指定查找源文件的位置
-classpath <路径列表> 指定查找用户类文件的位置
-exclude <软件包列表> 指定要排除的软件包的列表
-subpackages <子软件包列表> 指定要递归装入的子软件包
-breakiterator 使用 BreakIterator 计算第 1 句
-bootclasspath <路径列表> 覆盖引导类加载器所装入的类文件的位置
-source <版本> 提供与指定版本的源兼容性
-extdirs <目录列表> 覆盖安装的扩展目录的位置
-verbose 输出有关 Javadoc 正在执行的操作的消息
-locale <名称> 要使用的语言环境，例如 en_US 或 en_US_WIN
-encoding <名称> 源文件编码名称
-quiet 不显示状态消息
-J<标志> 直接将 <标志> 传递给运行时系统

注释规范

一、原则
1.注释形式统一
在整个应用程序中，使用具有一致的标点和结构的样式来构造注释。如果在其它项目中发现它们的注释规范与这份文档不同，按照这份规范写代码，不要试图在既成的规范系统中引入新的规范
2.注释内容准确简洁
内容要简单、明了、含义准确，防止注释的多义性，错误的注释不但无益反而有害
二、注释条件
1.基本注释（必须加）
(a)类（接口）的注释
(b)构造函数的注释
(c)方法的注释
(d)全局变量的注释
(e)字段/属性的注释
PS:简单的代码做简单注释，注释内容不大于10个字即可，另外，持久化对象或VO对象的getter、setter方法不需加注释
2.特殊必加注释
(a)典型算法必须有注释
(b)在代码不明晰处必须有注释
(c)在代码修改处加上修改标识的注释
(d)在循环和逻辑分支组成的代码中加注释
(e)为他人提供的接口必须加详细注释
PS:此类注释格式暂无举例。具体的注释格式自行定义，要求注释内容准确简洁
三、注释格式
1.单行(single-line)注释：“//……”
2.块(block)注释：“/*……*/”
3.文档注释：“/**……*/”
4.javadoc 注释标签语法
@author 对类的说明 标明开发该类模块的作者
@version 对类的说明 标明该类模块的版本
@see 对类、属性、方法的说明 参考转向，也就是相关主题
@param 对方法的说明 对方法中某参数的说明
@return 对方法的说明 对方法返回值的说明
@exception 对方法的说明 对方法可能抛出的异常进行说明

乱码解决方法

1、在项目列表中按右键，选择Export（导出），然后在Export(导出)对话框中选择Java下的javadoc，提交到下一步。
在Javadoc Generation对话框中有两个地方要注意的：
javadoc command:应该选择jdk的bin/javadoc.exe
destination:为生成文档的保存路径，可自由选择
按finish(完成)提交即可开始生成文档

2、用菜单选择：File->Export(文件－>导出)，剩下的步骤和第一种方法是一样的
3、选中要生成文档的项目，然后用菜单选择，
Project->Generate Javadoc直接进入Javadoc Generation对话框，剩余的步骤就和第一种方法在Javadoc Generation对话框开始是一样的
注意事项:
编码 GBK 的不可映射字符 
eclipse 生成javadoc乱码问题解决 
如果源文件编码使用了utf-8编码，那么生成的文档可会有乱码，解决办法如下：
Generate javadoc时， 在第三个对话框的"Extra Javadoc options" 文本框里面加上
-encoding UTF-8 -charset UTF-8