如何使用javadoc命令生成api文档,文档注释

如题所述

使用javadoc命令生成api文档:

    创建java源文件包。java文件都是存放在一个package包中,这样方便对java文件进行操作和区分,首先在磁盘上创建文件夹一样的方式创建package包。

    创建java源文件。在包下,创建与文件名相同的java源文件,输入一些文档注释,这些文档注释用于自动的api文件进行说明使用。

    进入java源文件目录。通过cd等windows命令进入java源文件包所在的磁盘位置。

    查看javadoc命令使用说明。如果是第一次使用javadoc命令,可以通过javadoc -help命令查看javadoc使用说明。

    开始创建api文件。使用命令输入javadoc -d javaapi -header 测试的API -doctitle 这是我的第一个文档注释 -version -author javadoc/Hello.java 进行文档生成。-d:文件存储位置; -head:文件头部名称; -version:显示版本; -author:显示作者; javadoc/Hello.java 处理的文件包以及java源文件。

    查看生成的api文件。创建成功之后,就会自动创建指定的文件夹下生成api文件。打开index.html就是api文件的入口。

温馨提示:内容为网友见解,仅供参考
第1个回答  2016-11-25
用法: javadoc [options] [packagenames] [sourcefiles] [@files]
-overview <file> 从 HTML 文件读取概览文档
-public 仅显示 public 类和成员
-protected 显示 protected/public 类和成员 (默认值
-package 显示 package/protected/public 类和成员
-private 显示所有类和成员
-help 显示命令行选项并退出
-doclet <class> 通过替代 doclet 生成输出
-docletpath <path> 指定查找 doclet 类文件的位置
-sourcepath <pathlist> 指定查找源文件的位置
-classpath <pathlist> 指定查找用户类文件的位置
-cp <pathlist> 指定查找用户类文件的位置
-exclude <pkglist> 指定要排除的程序包列表
-subpackages <subpkglist> 指定要递归加载的子程序包
-breakiterator 计算带有 BreakIterator 的第一个语句
-bootclasspath <pathlist> 覆盖由引导类加载器所加载的
类文件的位置
-source <release> 提供与指定发行版的源兼容性
-extdirs <dirlist> 覆盖所安装扩展的位置
-verbose 输出有关 Javadoc 正在执行的操作的信息
-locale <name> 要使用的区域设置, 例如 en_US 或 en_US_
-encoding <name> 源文件编码名称
-quiet 不显示状态消息
-J<flag> 直接将 <flag> 传递到运行时系统
-X 输出非标准选项的提要

通过标准 doclet 提供:
-d <directory> 输出文件的目标目录
-use 创建类和程序包用法页面
-version 包含 @version 段
-author 包含 @author 段
-docfilessubdirs 递归复制文档文件子目录
-splitindex 将索引分为每个字母对应一个文件
-windowtitle <text> 文档的浏览器窗口标题
-doctitle <html-code> 包含概览页面的标题
-header <html-code> 包含每个页面的页眉文本
-footer <html-code> 包含每个页面的页脚文本
-top <html-code> 包含每个页面的顶部文本
-bottom <html-code> 包含每个页面的底部文本
-link <url> 创建指向位于 <url> 的 javadoc 输出的链
-linkoffline <url> <url2> 利用位于 <url2> 的程序包列表链接至位于
的文档
-excludedocfilessubdir <name1>:.. 排除具有给定名称的所有文档文件子目录。
-group <name> <p1>:<p2>.. 在概览页面中, 将指定的程序包分组
-nocomment 不生成说明和标记, 只生成声明。
-nodeprecated 不包含 @deprecated 信息
-noqualifier <name1>:<name2>:... 输出中不包括指定限定符的列表。
-nosince 不包含 @since 信息
-notimestamp 不包含隐藏时间戳
-nodeprecatedlist 不生成已过时的列表
-notree 不生成类分层结构
-noindex 不生成索引
-nohelp 不生成帮助链接
-nonavbar 不生成导航栏
-serialwarn 生成有关 @serial 标记的警告
-tag <name>:<locations>:<header> 指定单个参数定制标记
-taglet 要注册的 Taglet 的全限定名称
-tagletpath Taglet 的路径
-charset <charset> 用于跨平台查看生成的文档的字符集。
-helpfile <file> 包含帮助链接所链接到的文件
-linksource 以 HTML 格式生成源文件
-sourcetab <tab length> 指定源中每个制表符占据的空格数
-keywords 使程序包, 类和成员信息附带 HTML 元标记
-stylesheetfile <path> 用于更改生成文档的样式的文件
-docencoding <name> 指定输出的字符编码本回答被提问者采纳
第2个回答  推荐于2018-04-18

代码如下:

[java] view plain copy

    /** 

    * 计算器工具类 

    *  

    * @author GaoHuanjie 

    * @version V1.0 

    */  

    public class ComputerUtil {  

    /* 

    * 加法运算 

    *  

    * @param a 加数a 

    * @param b 加数b 

    * @return 返回两个整数的和 

    */  

    public static int add(int a, int b){  

    return a+b;  

    }  

    /** 

    * 减法运算 

    *  

    * @param a 被减数 

    * @param b 减数 

    * @return 返回两个整数的差 

    */  

    public static int subtraction(int a, int b){  

    return a-b;  

    }  

    /** 

    * 乘法运算 

    *  

    * @param a 因数 

    * @param b 因数 

    * @return 返回两个整数的乘积 

    */  

    protected static int multiplication(int a, int b){  

    return a*b;  

    }  

    /** 

    * 除法运算 

    *  

    * @param a 被除数 

    * @param b 除数 

    * @return 返回两个整数的商 

    */  

    int division(int a, int b){  

    return a/b;  

    }  

    /** 

    * 取余运算 

    *  

    * @param a 被除数 

    * @param b 除数 

    * @return 返回两个整数的相除后的余数 

    */  

    private int residual(int a, int b){  

    return a%b;  

    }  

    }  

    步骤:

    ①、打开DOS窗口;

    ②、定位到到该类的源文件所在文件夹;

    ③、输入命令:javadoc -d c:\help -author -version ComputerUtil.java

    说明:-d:其后空一格,用来指定生成的帮助文档存放的位置;

    -author:用来指定生成的帮助文档必须显示该类的作者,如果没有这一命令则生成的帮助文档将不会显示作者;

    -version:用来指定生成的帮助文档必须显示该类的版本,如果没有这一命令则生成的帮助文档将不会显示版本;

    ④、点击回车键。

    结论:

    ①、Java中多行注释分为文档注释和非文档注释,只有文档注释所注释的内容才会出现在帮助文档中,非文档注释所注释的内容不会出现在帮助文档中(比如add方法,由于该方法的注释是非文档注释,所以注释内容没有生成到帮助文档中,只出现了该方法的一些信息);

    ②、只有被public和protected修饰的方法添加的文档注释的注释内容才能出现在帮助文档中,所以division方法和residual方法尽管采用了文档注释,但注释内容和方法信息却没有出现在帮助文档中;

本回答被网友采纳
相似回答