zoukankan      html  css  js  c++  java
  • JavaDoc注释

    标签 说明 JDK 1.1 doclet 标准doclet 标签类型
    @author 作者 作者标识 包、 类、接口
    @version 版本号 版本号 包、 类、接口
    @param 参数名 描述 方法的入参名及描述信息,如入参有特别要求,可在此注释。 构造函数、 方法
    @return 描述 对函数返回值的注释 方法
    @deprecated 过期文本 标识随着程序版本的提升,当前API已经过期,仅为了保证兼容性依然存在,以此告之开发者不应再用这个API。 包、类、接口、值域、构造函数、 方法
    @throws异常类名 构造函数或方法所会抛出的异常。   构造函数、 方法
    @exception 异常类名 同@throws。 构造函数、 方法
    @see 引用 查看相关内容,如类、方法、变量等。 包、类、接口、值域、构造函数、 方法
    @since 描述文本 API在什么程序的什么版本后开发支持。 包、类、接口、值域、构造函数、 方法
    {@link包.类#成员 标签} 链接到某个特定的成员对应的文档中。   包、类、接口、值域、构造函数、 方法
    {@value} 当对常量进行注释时,如果想将其值包含在文档中,则通过该标签来引用常量的值。   √(JDK1.4) 静态值域

     
     
     Javadoc命令格式如下:
    其中选项有:
    -overview <文件> 读取 HTML 文件的概述文档
    -public 仅显示公共类和成员
    -protected 显示受保护/公共类和成员(默认)
    -package 显示软件包/受保护/公共类和成员
    -private 显示所有类和成员
    -help 显示命令行选项并退出
    -doclet <类> 通过替代 doclet 生成输出
    -docletpath <路径> 指定查找 doclet 类文件的位置
    -sourcepath <路径列表> 指定查找源文件的位置
    -classpath <路径列表> 指定查找用户类文件的位置
    -exclude <软件包列表> 指定要排除的软件包的列表
    -subpackages <子软件包列表> 指定要递归装入的子软件包
    -breakiterator 使用 BreakIterator 计算第 1 句
    -bootclasspath <路径列表> 覆盖引导类加载器所装入的类文件的位置
    -source <版本> 提供与指定版本的源兼容性
    -extdirs <目录列表> 覆盖安装的扩展目录的位置
    -verbose 输出有关 Javadoc 正在执行的操作的消息
    -locale <名称> 要使用的语言环境,例如 en_US 或 en_US_WIN
    -encoding <名称> 源文件编码名称
    -quiet 不显示状态消息
    -J<标志> 直接将 <标志> 传递给运行时系统
  • 相关阅读:
    C# 模拟串口发送接收
    maven update解决TypeMismatchException
    [转载]JUnit3 与 JUnit4 的区别
    JUnit版本导致eclipse的build path加入的Maven Dependencies没起作用
    [转载][oracle]使用exp导出数据的日志中报warning如EXP-00091 Exporting questionable statistics
    [框架][MyBatis]MyBatis集锦
    [转载][工具]Secure CRT 自动记录日志和时间戳功能配置的方法
    jUnit Test遇到org.apache.ibatis.binding.BindingException
    [转载[工具]]PLSQL使用技巧
    [转载][工具]Eclipse Console 加大显示的行数,禁止弹出
  • 原文地址:https://www.cnblogs.com/fl72/p/7350714.html
Copyright © 2011-2022 走看看