Javadoc是Oracle公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形成程序的开发文档。
项目-->右键菜单Export-->Java下Javadoc-->next:
javadoc command:就是要调用的javadoc.exe,不用修改,eclipse会找到的;
use standard doclet:就是要生成到的目录,自定义一个文件夹作为存放目录[不然一大堆];
默认即可next-->再next-->
【注意注意】此时如果项目采用的是UTF-8编码,Extra Javadoc options下需要输入设定参数,否则生成的网页中文注释都是乱码。
-encoding utf-8 -charset utf-8
最后Finish完成。
在工程的doc 目录中,就有Javadoc 文档了
一般注释解释:
@author 作者名 @version 版本标识 @parameter 参数及其意义 @since 最早使用该方法/类/接口的JDK版本 @return 返回值 @throws 异常类及抛出条件 @deprecated 引起不推荐使用的警告 @see reference @override 重写
参考接口和类:
package test; /** * 测试接口 * @author java小强 * @version 0.0.1 */ public interface TestFace { }
类:
package test; /** * 测试文档输出<b>大写测试</b><br> * 已经换行<br> * Class <code>JavaBlogTest</code> is by java小强 * * @author java小强 * @version 0.0.1 * @since 1.5 */ public class JavaBlogTest implements TestFace{ /** 拼接到参数后返回 */ private String BACK = "_BACK"; /** * 获得新生 * @param oldStr 老参数 * @return 返回参数 * @exception IndexOutOfBoundsException if <code>oldStr</code> is null */ public String getStr(String oldStr){ return oldStr + BACK; } }
操作步骤和生成结果截图: