IDEA设置无警告的类注释和方法注释

类注释信息

Java注释

Java] 支持 3 种注释，分别是单行注释、多行注释和文档注释。文档注释以/**开头，并以*/结束，可以通过 Javadoc 生成 API 帮助文档，Java 帮助文档主要用来说明类、成员变量和方法的功能。

文档注释只放在类、接口、成员变量、方法之前，因为 Javadoc 只处理这些地方的文档注释，而忽略其它地方的文档注释。

Javadoc 是 Sun 公司提供的一种工具，它可以从程序源代码中抽取类、方法、成员等注释，然后形成一个和源代码配套的 API 帮助文档。也就是说，只要在编写程序时以一套特定的标签注释，在程序编写完成后，通过 Javadoc 就形成了程序的 API 帮助文档。

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

Javadoc标签

Javadoc 工具可以识别文档注释中的一些特殊标签，这些标签一般以@开头，后跟一个指定的名字，有的也以{@开头，以}结束。Javadoc 可以识别的标签如下表所示：

标签	描述	示例
@author	标识一个类的作者，一般用于类注释	@author description
@deprecated	指名一个过期的类或成员，表明该类或方法不建议使用	@deprecated description
{@docRoot}	指明当前文档根目录的路径	Directory Path
@exception	可能抛出异常的说明，一般用于方法注释	@exception exception-name explanation
{@inheritDoc}	从直接父类继承的注释	Inherits a comment from the immediate surperclass.
{@link}	插入一个到另一个主题的链接	{@link name text}
{@linkplain}	插入一个到另一个主题的链接，但是该链接显示纯文本字体	Inserts an in-line link to another topic.
@param	说明一个方法的参数，一般用于方法注释	@param parameter-name explanation
@return	说明返回值类型，一般用于方法注释，不能出现再构造方法中	@return explanation
@see	指定一个到另一个主题的链接	@see anchor
@serial	说明一个序列化属性	@serial description
@serialData	说明通过 writeObject() 和 writeExternal() 方法写的数据	@serialData description
@serialField	说明一个 ObjectStreamField 组件	@serialField name type description
@since	说明从哪个版本起开始有了这个函数	@since release
@throws	和 @exception 标签一样.	The @throws tag has the same meaning as the @exception tag.
{@value}	显示常量的值，该常量必须是 static 属性。	Displays the value of a constant, which must be a static field.
@version	指定类的版本，一般用于类注释	@version info

对两种标签格式的说明：

• @tag 格式的标签（不被{ }包围的标签）为块标签，只能在主要描述（类注释中对该类的详细说明为主要描述）后面的标签部分（如果块标签放在主要描述的前面，则生成 API 帮助文档时会检测不到主要描述）。
• {@tag} 格式的标签（由{ }包围的标签）为内联标签，可以放在主要描述中的任何位置或块标签的注释中。

Javadoc 标签注意事项：

• Javadoc 标签必须从一行的开头开始，否则将被视为普通文本。
• 一般具有相同名称的标签放在一起。
• Javadoc 标签区分大小写，代码中对于大小写错误的标签不会发生编译错误，但是在生成 API 帮助文档时会检测不到该注释内容。

Javadoc命令

Javadoc 用法格式如下：

javadoc [options] [packagenames] [sourcefiles]

对格式的说明：

• options 表示 Javadoc 命令的选项；
• packagenames 表示包名；
• sourcefiles 表示源文件名。

在 cmd（命令提示符）中输入javadoc -help就可以看到 Javadoc 的用法和选项（前提是安装配置了JDK），下面列举 Javadoc 命令的常用选项：

名称	说明
-public	仅显示 public 类和成员
-protected	显示 protected/public 类和成员（默认值）
-package	显示 package/protected/public 类和成员
-private	显示所有类和成员
-d	输出文件的目标目录
-version	包含 @version 段
-author	包含 @author 段
-splitindex	将索引分为每个字母对应一个文件
-windowtitle	文档的浏览器窗口标题

IDEA中在创建类时会自动给添加注释

关于网上很多注释

当前类注释信息

/**
 * @Title: ${NAME}
 * @author ${USER}
 * @date ${DATE} ${TIME}
 * @version 1.0
 * @description:  
 */

其中报错信息如下：

• @Title: As
• @date 2022/4/21 23:54
• @description:

​ 网上有太多的类注释信息用的@注解并不是Javadoc规范定义的，会有warning警告。原因如下：

• javadoc规范的正确的注释格式 @xxx yyy模式，但是网上很多教程的注释为@xxx：yyy 中间多了冒号
• 由于类的说明文字和方法的功能说明文字 是放在注释的最前面 因此有些教程的注释是使用xxx：yyy格式放在最前面，实际上并没有使用@表示是一个注解
• 由于以上原因很多教程的@第三方 注解 因此如果想在注解中表示其他信息 可以在IDEA的模板中 在注释的开头编写

比如如下的类注释并不会报错

/**
 * Project：${PROJECT_NAME}
 * Date：${DATE}
 * Time：${TIME}
 * Description：TODO
 * 
 * @author ${USER}
 * @version 1.0
 */

类注释

​ 设置路径： File–>settings–>Editor–>File and Code Templates–>Files

​

Java的类，接口等都引用了File Header,java文件

因此我们直接在Includes中直接

/**
 * Project：${PROJECT_NAME}
 * Date：${DATE}
 * Time：${TIME}
 * Description：TODO
 * 
 * @author ${USER}
 * @version 1.0
 */

前面的这些注释之所以不报错 并不是注解，对于Javadoc规范而言就是一般的功能注释

方法注释–Live Templates

打开Preferences-->Editor-->Live Templates

正常的方法注释习惯为/**然后回车，方法注释使用频繁，因此在设置方法注释时，为了保持/**的习惯。这里直接命名为*，另一个使用tab按。

设置groub和具体的template这里就不演示了。

最终版本的

*
 * date: $date$ $time$
 * TODO
 *
$param$ $return$      
 * @author $user$
 * @throws $throws$
 **/

为变量关联表达式

其中，param变量比较麻烦，因为参数不固定，需要使用groovyScript来动态显示，param表达式的内容如下

groovyScript("if(\"${_1}\".length() == 2) {return '';} else {def result='\\n'; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\n' : '')}; return result}", methodParameters())

return的注释

groovyScript("def result=''; def re = \"${_1}\"; if (re == 'void') {return result}; result ='\\n * @return ' + re; return result", methodReturnType())

throws 暂时无解决方案

(102条消息) idea注释模板怎么自动获取到throws的信息-Java-CSDN问答

使用方法注释

方法上面/** 加Tab会自动生成注释 然后格式化一下

生成javadoc

tool-generate javadoc
选择whole project，指定输出文件夹output directory，locale选zh_CN即生成中文html，other command arguments设置如下，其中-tag是自定义的标签，将在javadoc中显示

-encoding UTF-8 -charset UTF-8 -tag date:a:"date"

注意事项：

• @***后面不是：，而是空格

• 无返回值的方法提示@return 用法有误，直接删除该@return 注释即可

• 取消勾选include test source即可剔除test类

• @throws 每行只能写一个exception，如有多个exception需分为多行@throws

• 描述性注释应放在注释的前面，不需要用@***修饰