/**
* <h3>Title:</h3><hr/>
* <p>Description:Create By juner On ${MONTH}/${DAY}/${YEAR}</p>
* @author juner(夜路沏茶人)
* @date ${YEAR}年${MONTH}月${DAY}日 ${TIME} ${DAY_NAME_FULL}
* @since JDK_1.8
* @see ${PACKAGE_NAME}
* @version 0.0.1
*/
原因:
<h3></h3>
用于指明类概述,此处只能是 h3 标签(别问,问就是规范。JDK1.8加入了doclint,doclint遵循W3C HTML 4.01标准)
<p></p>
用于指明类文件详细描述@author
用于指明作者信息,多个作者需要多个@author@date
用于指明第一次创建时的创建日期@since
用于指明JDK版本信息@see
用于指明参考类。此处记录当前包路径@version
用于指明版本迭代信息
doclint:
- 不能有自关闭的HTML tags,例如
<br/>
或者<a id="x"/>
- 不能有未关闭的HTML tags,例如有
<ul>
而没有</ul>
- 不能有非法的HTML end tags,例如
</br>
- 不能有非法的HTML attributes,需要符合doclint基于W3C HTML 4.01的实现
- 不能有重复的HTML id attribute
- 不能有空的HTML href attribute
- 不能有不正确的嵌套标题,例如类的文档说明中必须有
<h3>
而不是<h4>
- 不能有非法的HTML tags,例如List需要用<>对应的实体符号
- 不能有损坏的
@link references
- 不能有损坏的
@param references
,它们必须匹配实际的参数名称 - 不能有损坏的
@throws references
,第一个词必须是一个类名称