IDEA 中的文档注释

• 前言
• 处理
• 根本原因及总结

很久没有玩Java了，创建类的时候发现自动带有注释，应该是以前设置的文档注释，但是IDEA总是有警告提示说错误标签，就很奇怪，文档注释怎么会出错呢？

于是我就翻看了下Class的模板，里面是这样的内容

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")

public class ${NAME} {
}

嗯，出现问题的位置在第二行，那应该是这个Header.java里写得有问题
可是，我哪想起来它在哪啊，左点点右看看，找了好久，好家伙，最后竟发现就在文件栏旁边（即：Includes）…

好了，删了就行了

之所以被警告提示：错误标签，是因为我之前设置的@xxx，在它的预定义变量里面没有，接收不到值，所以会有警告。因而，不管对文件头，类，方法还是其他的，设置@xxx的时候应尽量遵循其预定义变量

下面是这个文件的描述及其预定义变量所对应的值

包含一个代码片段，可以在 #parse 指令的帮助下将其包含在文件模板（Templates 选项卡）中。 此内置模板是可编辑的。 除了静态文本、代码和注释外，您还可以使用预定义变量，这些变量随后将像宏一样被扩展为相应值。 
预定义变量接收以下值：
${PACKAGE_NAME}
 在其中创建新文件的软件包名称

${USER}
当前的用户系统登录名

${DATE} 
当前系统日期

${TIME} 
当前系统时间

${YEAR} 
当前年度

${MONTH} 
当前月份

${MONTH_NAME_SHORT} 
当前月份名称的前 3 个字母。 例如：Jan、Feb 等

${MONTH_NAME_FULL} 
当前月份的全名。 例如：January、February 等

${DAY} 
当前月份的日期

${DAY_NAME_SHORT} 
当前日期名称的前 3 个字母。 例如：Mon、Tue 等

${DAY_NAME_FULL} 
当前日期的全名。 例如：Monday、Tuesday 等

${HOUR} 
当前小时

${MINUTE} 
当前分钟

${PROJECT_NAME} 
当前项目名称