Javadoc简单入门

资料来自百度百科:

  百度百科:Javadoc

一些简单的标签:

/*
    Javadoc基本知识:

        标签类型:所有:
            @deprecated+过期文本    :标识随着程序版本的提升,当前API已经过期,仅为了保证兼容性依然存在,以此告之开发者不应再用这个API。
            @see+引用              :查看相关内容,如类、方法、变量等。
            @since+描述文本         :API在什么程序的什么版本后开发支持。
            {@link包.类#成员 标签}  :链接到某个特定的成员对应的文档中。


        标签类型:包、类、接口:
            @author+作者        :作者标识
            @version+版本号     :版本号

        标签类型:方法或构造函数:
            @param+参数名描述    :方法的入参名及描述信息,如入参有特别要求,可在此注释。
            @return+描述        :对函数返回值的注释
            @exception+异常类名  :同@throws。
            @throws+异常类名     :构造函数或方法所会抛出的异常。

        标签类型:静态值域:
            {@value}    :当对常量进行注释时,如果想将其值包含在文档中,则通过该标签来引用常量的值。
 */

Javadoc指令的应用:

/*
    Javadoc命令格式如下:
        javadoc [选项] [软件包名称] [源文件]
    
        其中选项有:
            -package    :显示软件包/受保护/公共类和成员
            -public     :仅显示公共类和成员
            -protected  :显示受保护/公共类和成员(默认)
            -private    :显示所有类和成员
            
            -doclet <class>              :通过替代 doclet 生成输出
            -docletpath <path>           :指定查找 doclet 类文件的位置
            -sourcepath <pathlist>       :指定查找源文件的位置
            -classpath <pahtlist>        :指定查找用户类文件的位置
            -exclude <packagelist>       :指定要排除的软件包的列表
            -subpackages <subpackagelis> :指定要递归装入的子软件包
            -bootclasspath <pathlist>    :覆盖引导类加载器所装入的类文件的位置
            -extdirs <dirlsit>           :覆盖安装的扩展目录的位置
            
            -overview <file>   :读取 HTML 文件的概述文档
            -breakiterator     :使用 BreakIterator 计算第 1 句
            -source <version>  :提供与指定版本的源兼容性
            -verbose           :输出有关 Javadoc 正在执行的操作的消息
            -locale <name>     :要使用的语言环境,例如 en_US 或 en_US_WIN
            -encoding <name>   :源文件编码名称
            -help              :显示命令行选项并退出
            -quiet             :不显示状态消息
            -J<flag>           :直接将 <flag> 传递给运行时系统
 */

猜你喜欢

转载自www.cnblogs.com/junjie2019/p/10626311.html