携手创作，共同成长！这是我参与「掘金日新计划 · 8 月更文挑战」的第 2 天，点击查看活动详情

idea 自定义文档注释模板

• 文档注释是怎么创建的？键入 '/**' + Enter(回车)。

• 分解后就是：/* + [缩写] + Enter

• 默认的 样式：

/**
 * 类的主要描述
 *
 * @param <E>
 * @param <PK>
 */

/**
 * 方法的主要描述
 *
 * @param e
 * @return
 */

• 这明显不满足我们的需求，我们还要更多的标签，如 @version，下面是自定义方案。

自定义 一套文档注释模板

• 用在类创建完成后，添加类注释、方法注释，Java 文件创建无变化。

• 选中 Files(文件) -> settings(设置) -> Editor(编辑器) -> Live Templates(实时模板)

• 先点击 '+' 添加模板组(第二个)，我命名为 Notes；再点击 '+' 添加动态模板(第一个)。

• 然后 填写缩写、填写模板文本、选择语言、编辑模板中的变量、选择展开方式。

• 建议：缩写不要写 '*'，展开方式用 'Tab'。

• 参考：

缩写：'cn'，展开方式：'Tab'。

/**
 *
 * @author LJM
 * @date $date$
 * @version
 * @see
 */

效果

/**
 * @author LJM
 * @date 2022/8/5
 * @version
 * @see
 */

缩写：'mn'，展开方式：'Tab'。

/**
 *
 * @param $param$
 *
 * @return
 */

• 写好后，添加注释的快捷键则有：cm/mn + Tab、cm/mn + Enter、/* + cm/mn + Tab。

• 要在设置语言时选中注解才可以，用 /* + cm/mn + Tab 快捷键，图片上没有的，要加。

• 模板文本中的字符只有两种，一种是用 '$' 符号包裹的变量，一种是其他的字符串（空格、字符、字母、文字 等等）。

• 在变量编辑页面，将变量与方法绑定后，添加注释时，变量就会自读替换为 方法返回值。

• 日期的方法是：date()，时间的方法是：time() 等等，基本可以通过名称推断出功能。

• 但，部分函数只有使用 /* + cm/mn + Tab 快捷键创建时才执行（methodParameters()、methodReturnType() 等）。

• 使用 /* + cm/mn + Tab 快捷键创建注释时，结果是：

/*/**
 * @author LJM
 * @param [a, ac, ba]
 * @date 2022/8/5
 * @version
 * @param
 */

预期结果是：

/**
 * @author LJM
 * @param a
 * @param ac
 * @param ba
 * @date 2022/8/5
 * @version
 * @param
 */

多了 '/*'，同时参数合适数组形式，所以还是用 /* + cm/mn + Enter 快捷键创建默认注释吧。

在文件中添加 类的文档注释模板

• 此方法改变了创建 Java 文件时（即：建类时）生成的类文档注释，默认是没有的（即：空白）。

• 用在创建 Java 文件时。

• 选中 Files(文件) -> settings(设置) -> Editor(编辑器) -> File and Code Templates(文件和代码模板)

• 是 File Header 文件，默认是空的。

参考：

/**
 *
 * @author LJM
 * @date ${DATE}
 * @version
 * @see
 */

效果：(@version 不见了，我也不知道为什么)

/**
 * @author LJM
 * @date 2022/8/5
 * @see
 */

• 同模板文本一样，文件中的字符只有两种，一种是用 '${}' 符号包裹的变量，一种是其他的字符串（空格、字符、字母、文字 等等）。

• 在文件生成时，会将变量替换为 相应的值，按需添加。

常用的变量的含义

• ${PACKAGE_NAME} 该文件的名称

• ${USER} 当前用户电脑系统登录名

• ${DATE} 日期（年月日）

• ${TIME} 时间（时分秒）

• ${YEAR} 年份

• ${MONTH} 月份

• ${MONTH_NAME_SHORT} 月份（短）如：8月

• ${MONTH_NAME_FULL} 月份（长）如：八月

• ${DAY} 天，如：05

• ${DAY_NAME_SHORT} 天（短），如：周五

• ${DAY_NAME_FULL} 天（长），如：星期五

• ${HOUR} 小时

• ${MINUTE} 分钟

• ${PROJECT_NAME} 项目 名称

• ${PRODUCT_NAME} 开发工具 名称

(二发)如果对你有帮助，点赞可好！！