方法注释:

@param  变量描述
@return 描述
@throws 类描述

域注释:

通用注释:

@author 姓名
@version 文本
@since 始于
@deprecated 文本(添加不再使用的注释,通过@see和@link链接新的javadoc)
@see 引用(栗子:@see com.bingchunmoli.api.SpringBootApplication#main(String) PS: 包名类名省略即为当前类,当前包)
@link 同上

包与概述注释:

  1. 提供一个package.html命名的HTML文件在Body中的所有文本都会抽取出来
  2. 提供一个package-info.java 命名的Java文件。这个文件必须包含一个/** */为界定的java注释跟随在包语句之后。它不应该包含更多的代码和注释.
  3. 还可以为所有源文件提供一个概述性的描述。注释应该放置在overview.html的文件中。这个文件位于包含所有源文件的父目录。body将会被抽取。

Q.E.D.

知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议