自动生成类注释

自动生成类注释

利用“文件和代码模板”功能实现。

选择File - Setting - Editor - File and Code Templates 然后选择Includes中的File Header，右侧编辑框添加你的自定义的注释保存即可。

我的注释如下：

/**
 * 
 * @author : ${USER} initit@aliyun.com
 * @version 1.0.0
 * @date : ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
 */

其中的变量含义如下：

${PACKAGE_NAME}:当前项目名称
${USER}:当前系统登录名
${DATE}: 当前系统日期
${TIME}：当前系统时间
${YEAR}：当前年份
${MONTH}： 当前月份
${MONTH_NAME_SHORT}：当前月份的前三个字母，如：Jan, Feb,等等
${MONTH_NAME_FULL}： 当前月份的全称，如：January, February,等等
${DAY}： 本月的当期日期
${DAY_NAME_SHORT}： 本月的当期日期的前三个字母，如：Mon, Tue,等等
${DAY_NAME_FULL}： 当期日期的全称，如：onday, Tuesday, 等等
${HOUR}： 当前小时
${MINUTE}：当期分钟
${PROJECT_NAME}：当期项目名称
版本引擎使用的是 Apache Velocity

附录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

编程指南

创建类默认生成注释

自动生成类注释