javadoc工具生成开发者文档

命令：

          javadoc -d 存放文档的路径 java的源文件

          javadoc -version -author -d 存放文档的路径 java的源文件

 

注：

          只有public/protected修饰的类，才能用javadoc命令生成开发者文档。

          文档注释的注释内容会被写到开发者文档中。

 

文档注释：

           /**

               注释内容

           */

 写在 类/接口/字段/方法 开始之前即可。

 

//以"@"开头的命令;
1.类文档标记
  ----包括:版本信息/作者。
（1）@version 版本信息:
        从生成的HTML提版本信息。
        对应"javadoc -version"
（2）@author 作者信息
        可包括：姓名/email。
        对应 "javadoc -author"
--------------------------------------
2.方法文档标记
  ----参数/返回值/异常。
（1）@param 参数名 说明
（2）@return 说明 指返回值的含义。
（3）@exception 完整类名 说明
    “完整类名”定义好的异常类名。
（4）@deprecated  不建议使用，将来可能摈弃。

 

---------------------------------------------------------------------------------------------

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

---------------------------------------------------------------------------------------------

Eclipse文档注释生成方法： 

1.项目-->右键菜单Export-->Java下Javadoc-->next：
<1>javadoc command:就是要调用的javadoc.exe，不用修改，eclipse会找到的；
<2>use standard doclet:就是要生成到的目录，自定义一个文件夹作为存放目录[不然一大堆]；
<3>默认即可next-->再next-->
<4>【注意注意】此时如果项目采用的是UTF-8编码，Extra Javadoc options下需要输入设定参数：-encoding utf-8 -charset utf-8否则生成的网页中文注释都是乱码。
<5>最后Finish完成。
在工程的doc 目录中，就有Javadoc 文档了

 

eclipse下，当鼠标处于类，方法定义行时，按Alt+Shift+J，快速添加文档注释。

设置默认格式：file > export > javadoc >