锐客网

  1. 首页 > it技术 > >

Java|Java23（javadoc文档注释）

java

Javadoc 是 Sun 公司提供的一种工具，它可以从程序源代码中抽取类、方法、成员等注释，然后形成一个和源代码配套的 API 帮助文档。也就是说，只要在编写程序时以一套特定的标签注释，在程序编写完成后，通过 Javadoc 就可以自动生成程序的 API 帮助文档。
文档注释以/**开头，以*/结束，可以通过 Javadoc 生成 API 帮助文档，Java帮助文档主要用来说明类、成员变量和方法的功能。
文档注释只放在类、接口、成员变量、方法之前，因为 Javadoc 只处理这些地方的文档注释，而忽略其它地方的文档注释。
javadoc标签
Javadoc 工具可以识别文档注释中的一些特殊标签，形式上标签分为2类：
  • 块标签@...
    只能放在主要描述后面（主要描述：类注释中对该类的详细说明。）
    （如果块标签放在主要描述的前面，则生成 API 帮助文档时会检测不到主要描述）
  • 内联标签{@...}
    可以放在主要描述中的任何位置或块标签的注释中

注意：
  • Javadoc 标签必须从一行的开头开始，否则将被视为普通文本。
  • 一般具有相同名称的标签放在一起。
  • Javadoc 标签区分大小写，代码中对于大小写错误的标签不会发生编译错误，但是在生成 API 帮助文档时会检测不到该注释内容。
javadoc命令
用法格式：javadoc?选项参数?包名?源文件名
终端中输入javadoc -help就可以看到 Javadoc 的用法和选项（前提是安装配置了JDK）
常用命令

【Java|Java23（javadoc文档注释）】API 帮助文档相当于产品说明书，而说明书只需要介绍那些供用户使用的部分，所以 Javadoc 默认只提取 public、protected 修饰的部分。如果要提取 private 修饰的部分，需要使用 -private。

    推荐阅读


    上一篇：Machine|scikit-learn-分类模型评价标准

    下一篇：读书报告|读书报告 《就在身边的特别之所》三谷龙二著