利用javadoc生成API文档

利用javadoc生成API文档

何为文档注释

以“/**”开始，“*/”结束

/** *Description: *<br>This is the Main Class which contains the main method *<br>website: <a href="http://www.baidu.com">www.baidu.com</a> * * @author FIRE_TRAY [email protected] * @version 1.0 */

public class Main {
    /** * the ret String */
    public static String s = "HelloWorld";

    /** * the entrance of this Java application * @param args the arguments passed from the console command */
    public static void main(String[] args)
    {
        System.out.println(s);
    }
}

由于文档注释用于生成API文档，而API文档住哟啊用于说明类、方法、成员变量的功能，因此JavaDoc工具处理源文件在类、接口、方法成员变量、构造器和内部类之前的注释，忽略其他地方的文档注释。而且javadoc工具默认只处理以public或protected修饰的class,interface,method,成员变量,constructor和内部类之前的文档注释。

—如果开发者希望将private的注释暴露给使用者，可以在使用javadoc工具时增加-private选项

如何解决中文乱码问题

在命令行javadoc Main.java后，调节chrome的编码为自动检测，或者手动试试utf-8 or GBK。

操作步骤： 菜单 -> 更多工具 -> 编码

javadoc常见选项

• javadoc *.java 表示此路径下的所有Java文件都要导出javadoc
• -d [dierctory] 指定doc的生成目录，用于将API文档放在指定的目录下，没有默认为当前路径
• -windowtitle [text] 该选项指定一个字符串，用于设置api文档的浏览器窗口标题，标题过长应该用’_’隔开，而不要使用空格
• -doctitle [html-code] 该选项指定一个HTML格式的文本，用于指定概述页面的标题。注意，只有在多个包下的源文件生成API时，才有概述页面
• -header [html-code] 设置页眉样式
• -private 暴露private的注释
• -version 加入版本信息
• -author 加入作者

Javadoc的标记

• @author 指定作者
• @version 版本
• @deprecated （adj. 弃用的，不赞成的） 不推荐使用的方法，加入此标记时方法名称会加入删除线
• @param
• @return
• @see 参见，用与交叉参考内容
• @exception 表明会抛出的异常类型
• @throws 抛出的异常与exception同义词

—javadoc 默认不会提取author 和 version这两个标记，如果需要，那么需要加入 -version -author 的选项