javadoc语法总结

javadoc可以根据项目代码的注释（当然是规范化的）自动生成HTML格式的API文档。哇哦，可以不用自己写一个字就能自动生成文档了，哈。

三种注释类型（注释必须紧贴着注释体，不然javadoc会忽略）：
类注释
变量注释
方法注释

书写格式：
/** <-- 必须为两个星号才符合javadoc注释风格
 * ........
 * @XXX <-- 可以加入javadoc参数，产生相应的文档
 */

参数说明：
@see 生成文档中的“参见xx 的条目”的超链接，后边可以加上：“类名”、“完整类名”、“完整类名#方法”。可用于：类、方法、变量注释。
@param 参数的说明。可用于：方法注释。
@return 返回值的说明。可用于：方法注释。
@exception 可能抛出异常的说明。可用于：方法注释。
@version 版本信息。可用于：类注释。
@author 作者名。可用于：类注释。

javadoc命令：
javadoc [options] [packagenames] [sourcefiles]

-public 仅显示 public 类和成员
-protected 显示 protected/public 类和成员 (缺省)
-package 显示 package/protected/public 类和成员
-private 显示所有类和成员
-d <directory> 输出文件的目标目录
-version 包含 @version 段
-author 包含 @author 段
-splitindex 将索引分为每个字母对应一个文件
-windowtitle <text> 文档的浏览器窗口标题