• 【JavaDoc注释风格详解】


    JavaDoc注释简介

    JavaDoc是Java代码的一种注释风格,可以用JavaDoc命令生成API文档。

    JavaDoc常用标签

    也可以用编译器的快捷键,直接生成JavaDoc注释

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

    此处还有@serial,@serialField,@serialData,{@docRoot},{@inheritDoc},{@literal},{@code},{@value arg}这几个不常用的标签,由于不常使用,这里不展开叙述,感兴趣的读者可以查看帮助文档。

    JavaDoc命令详解

    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<标志> 直接将 <标志> 传递给运行时系统

  • 相关阅读:
    强化服务器安全!CentOS 7如何使用fail2ban防范SSH暴力破解攻击?
    java-后端调用第三方接口返回图片流给前端
    Vue 3 快速上手指南(第二期)
    基于SpringBoot的篮球竞赛预约平台
    Java实现敏感日志脱敏
    python返回多个值与赋值多个值
    【特征选择】基于教与学算法实现二进制特征选择问题附matlab代码
    亲和力的作用,以及提高亲和力的六个办法
    如何实现基于图像与激光雷达的 3d 场景重建?
    集合体系图
  • 原文地址:https://blog.csdn.net/yang13676084606/article/details/127669030