1. 概要
javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形成程序的开发文档了。
本文要说的是:通过javadoc生成APIDoc的过程,使用了Eclipse
在Windows下的表现形式就是它了:
2. 注释模板
使用我这种注释代码能生成好看和较为标准的APIDoc
Types - 类和接口注释
/** * 概述……。 * * <p>描述……</p> * <ul><li></li></ul> * <br> * <strong>Time</strong> ${date}<br> * <strong>copyright</strong> 2016, XXXX有限公司<br> * * @version 1.0.0 * @author ${user} */
注意,第一行最后加上”。”可以让javadoc自动判断要显示的类摘要。
Methods - 方法使用默认的就好
/** * ${tags} */
这个就是默认的。会自动生成@param和@return标记,自己在具体参数后面写上具体注释就好了。
注意,自己在第一行写描述时,写完也要加上”。”,原因同上
3. Eclipse中操作过程
右键选中项目或者具体的包/类都可以,选择Export,之后如下图:
选择源types(类)、Destination(目标路径)
选择生成选项、哪些tags(标记)等,使用默认就可以
根据项目编码指定虚拟机参数,完成
生成的目录结构如下,点击index.html就可以看了