javadoc的使用及eclipse生成
2014-10-09 11:09
281 查看
1.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 文档了
---------------------------------------------风骚的分割线------------------------------------------------
2.javadoc的使用说明:
如何规范生成JAVADOC帮助文档
1.”文本注释“=也叫归档注释。
归档注释代码
"/** */"
归档注释是专用注释;
类或类成员声明之前;
javadoc工具提取它们来生成HTML文档。
归档注释:
1.类/接口/方法/字段生命之前。
2.“文档标记”
文档标记代码
//以"@"开头的命令;
1.类文档标记
----包括:版本信息/作者。
(1)@version 版本信息:
从生成的HTML提版本信息。
对应"javadoc -version"
(2)@author 作者信息
可包括:姓名/email。
对应 "javadoc -author"
--------------------------------------
2.方法文档标记
----参数/返回值/异常。
(1)@param 参数名 说明
(2)@return 说明 指返回值的含义。
(3)@exception 完整类名 说明
“完整类名”定义好的异常类名。
(4)@deprecated 不建议使用,将来可能摈弃。
3.只为 "public/protected" 处理注释文档。
"private"和"default" 注释会被忽略,看不到输出
可用-private标记包括private。
---------------------------------------------风骚的分割线------------------------------------------------
3.文档注释快捷键
eclipse下,当鼠标处于类,方法定义行时,按Alt+Shift+J,快速添加文档注释。
设置默认格式:file > export > javadoc >
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 文档了
---------------------------------------------风骚的分割线------------------------------------------------
2.javadoc的使用说明:
如何规范生成JAVADOC帮助文档
1.”文本注释“=也叫归档注释。
归档注释代码
"/** */"
归档注释是专用注释;
类或类成员声明之前;
javadoc工具提取它们来生成HTML文档。
归档注释:
1.类/接口/方法/字段生命之前。
2.“文档标记”
文档标记代码
//以"@"开头的命令;
1.类文档标记
----包括:版本信息/作者。
(1)@version 版本信息:
从生成的HTML提版本信息。
对应"javadoc -version"
(2)@author 作者信息
可包括:姓名/email。
对应 "javadoc -author"
--------------------------------------
2.方法文档标记
----参数/返回值/异常。
(1)@param 参数名 说明
(2)@return 说明 指返回值的含义。
(3)@exception 完整类名 说明
“完整类名”定义好的异常类名。
(4)@deprecated 不建议使用,将来可能摈弃。
3.只为 "public/protected" 处理注释文档。
"private"和"default" 注释会被忽略,看不到输出
可用-private标记包括private。
---------------------------------------------风骚的分割线------------------------------------------------
3.文档注释快捷键
eclipse下,当鼠标处于类,方法定义行时,按Alt+Shift+J,快速添加文档注释。
设置默认格式:file > export > javadoc >
相关文章推荐
- 使用eclipse生成文档(javadoc)
- 使用eclipse生成文档(javadoc)
- 使用eclipse生成javadoc的方法
- 使用eclipse生成文档(javadoc)主要有三种方法:
- 使用eclipse生成html格式注释文档 [ javadoc ]
- 使用eclipse生成html格式注释文档 [ javadoc ]
- eclipse使用——生成jar和生产javadoc
- 使用eclipse生成文档(javadoc)
- 使用eclipse生成javadoc文档
- 使用Eclipse生成JavaDoc乱码的解决方法
- 转:使用eclipse生成文档(javadoc)的方法
- 使用 Eclipse 生成 javadoc
- 使用eclipse生成javadoc的方法
- 使用Eclipse生成JavaDoc乱码的解决方法
- 使用eclipse生成html格式注释文档 [ javadoc ]
- 使用Eclipse生成javadoc
- javadoc的使用及eclipse生成
- 使用 Eclipse 生成 javadoc
- 使用eclipse生成javadoc的方法
- 使用eclipse生成文档(javadoc)