Question

如何在eclipse添加javadoc

Answer 1

先看默认状态的吧，新建类文件时，是不生成注释的

在
windows-->preferenceJava-->Code Style-->Code Templatescode-->new Java file

编辑文件为7的样式，（为了方便起见，中间分布截图说明，熟悉的朋友直接跳到7）
对于中文版本
窗口-->首选项
java-->代码样式-->代码模板
代码-->新的java文件
菜单栏，窗口——首选项

找到java选项-->代码样式

注释-->新生成的java文件

直接编辑配置文件
在配置文件中间添加注释代码，这部分可以自定义，参考如下，关键字解释见后文10
------------------我是分割线，别复制我-----------------------------------
${filecomment}${package_declaration}/** * @author 作者 E-mail: * @date 创建时间：${date} ${time} * @version 1.0 * @parameter * @since * @return */${typecomment}${type_declaration}
------------------我是分割线，别复制我-----------------------------------
现在新建文件将自动生成注释

补充说明;
也许你看到我们在写注释文件时用到了很多关键字，那么这里我们就了解一下Javadoc
Javadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形成程序的开发文档了
关键词列表：
@author 作者名
@date 日期
@version 版本标识
@parameter 参数及其意义
@since 最早使用该方法/类/接口的JDK版本
@return 返回值
@throws 异常类及抛出条件
@deprecated 引起不推荐使用的警告
@see reference 查看引用
@override 重写

Answer 2

假设源代码在 C:\src 目录下，其中 com.liigo 是主包，其下可能有数十个子包，数百（千）个Java文件。目录结构大约是这样的：

- C:\
| src\
| com\
| liigo\

| ***
怎么才能以最简捷的方式生成所有的API文档呢？

c:\>
c:\>cd src
c:\src>javadoc -d doc -subpackages com.liigo

这样就搞定了，最终生成的API文档位于 c:\src\doc 目录（该目录是由javadoc.exe自动生成的）。

上面的用法利用了“当前目录”和“相对路径”，当然也可以用绝对路径：

...>javadoc -d c:\doc -sourcepath c:\src -subpackages com.liigo

最终生成的API文档位于 c:\doc 目录（该目录同样是由javadoc.exe自动生成的）。

总结一下：

我们只用到了javadoc的三个参数： -d，-subpackages，-sourcepath，其中：

参数 说明
-d 指定API文档的输出目录，默认是当前目录。建议总是指定该参数。
-sourcepath 指定源代码路径，默认是当前目录。 此参数通常是必须的。
-subpackages 以递归的方式处理各子包。关键参数！如果不使用本参数，每次只能处理一个子包（或需手工列出所有子包）。

注：以上示例要求 javadoc.exe 所在路径位于系统环境变量“PATH”中。

补充一点：

使用参数 -author 可以将作者信息（@author ***）导出到最终生成的API文档中， -version 可以生成版本信息。如果是自己写的一个包，千万不要忘了用 -author 哦:)

最终完整的命令行是：

...>javadoc -d c:\doc -sourcepath c:\src -subpackages com.liigo -author -version