idea 注释模板设置

在 IntelliJ IDEA 中设置注释模板的步骤如下：

  1. 打开 IntelliJ IDEA，点击顶部菜单的 File > Settings(在 macOS 上是 IntelliJ IDEA > Preferences)。

  2. 在设置对话框中，选择 Editor > File and Code Templates。

  3. 在打开的页面中，你可以看到 Files 和 Includes 两个选项卡。

  4. 在 Files 选项卡中，选择 Class，这里你可以设置类注释的模板。

  5. 在 Includes 选项卡中，选择 File Header，这里你可以设置文件头部的注释模板。

  6. 在编辑区域中，你可以输入自定义的注释模板内容。例如，一个简单的类注释模板可以是：

/*
 * @Author ${USER}
 * @Description ${NAME}
 * @Date ${DATE} ${TIME}
 * @param ${params}
 * @return ${return}
 */

  1. 完成模板编辑后，点击 Apply 然后 OK 保存你的设置。

  2. 当你在代码中创建新的类时，IDEA 将自动应用你设置的注释模板。

如果你需要为方法添加注释模板，你可以使用 Live Templates 功能：

  1. 在 Settings 对话框中，选择 Editor > Live Templates。

  2. 点击 + 按钮创建一个新的模板，并设置模板的缩写、描述和模板文本。

  3. 在 Abbreviation 字段中输入一个简短的缩写，以便在编写代码时快速输入模板。

  4. 在 Template text 中输入注释模板内容，例如：

/**
 * @since: 1.14.1
 * @param: $params$
 * @return: $returns$
 * @author: ${USER}
 * @date: ${DATE} ${TIME}
 */

  1. 设置 Expand with 为 Tab，这样在输入缩写后按 Tab 键即可展开模板。

  2. 根据需要配置模板参数，例如 params 和 returns，可以使用 Groovy 脚本自定义参数的处理方式。

完成以上步骤后，你就可以在 IntelliJ IDEA 中使用自定义的注释模板了

Top
×
×