eclipse里设置JavaDoc

来源：互联网发布：node.js 编译编辑：程序博客网时间：2024/05/16 17:21

为了更好的生成注释，在Java里可以用JavaDoc很方便的生成注释。

1。配置：

使用JavaDoc前，必须安装jdk，因为JavaDoc需要用到jdk的一个exe文件。

点击菜单Project|Generate JavaDoc，第一次使用时需要指定javadoc的路径：C:\Program Files\Java\jdk1.6.0_01\bin\javadoc.exe。

生成后的JavaDoc位于工程目录的doc目录，里面有个index.html。

2。设置JavaDoc编码：

如果Java文件采用UTF-8编码，产生JavaDoc时会报错：编码 GBK 的不可映射字符，这时需要配置javadoc的选项：-encoding UTF-8 -charset UTF-8

3。如何为Package生成注释：

在每个Package目录下放一个package.html，内容只需要<body></body>就可以了。其中body内的第一行为包概述，以英文.或中文。结尾，body内的所有内容为包描述。

package.html内容示例：

<BODY>测试包。<BR />这个测试包里面包含含有main函数的测试用例。<BR /></BODY>

包概述：

包描述：

0 0