如何配置IDEA注释模板，领导见了都说好

2023-11-12 00:43:59

在软件开发中，注释是理解代码逻辑、提高代码可读性和可维护性的关键部分。IntelliJ IDEA，这款流行的Java开发工具，提供了灵活的注释模板功能，帮助开发者快速生成结构良好的注释。本文将详细介绍如何在IDEA中配置注释模板，并提供实用示例，以提升您的编码效率。

一、类注释

打开设置
在IDEA中，点击 File -> Settings（Windows/Linux）或 IntelliJ IDEA -> Preferences（Mac）。
导航到文件和代码模板
在设置窗口中，找到并点击 Editor -> File and Code Templates。
编辑类模板
在 File and Code Templates 页面中，选择 Files 标签下的 Class，然后点击右侧的 + 按钮添加新的注释模板。
添加注释模板内容
在弹出的对话框中，输入以下内容：
```
/**
 * ${NAME}
 *
 * @author ${USER}
 * @date ${DATE}
 */
```
点击 OK 保存。
使用注释模板
当你在类名上按住 Alt + Enter 时，IDEA会自动插入你刚刚设置的注释模板。

假设你有一个类名为 User，按照上述步骤配置后，当你输入 User 并按 Alt + Enter 时，IDEA会自动生成：

/**
 * User
 *
 * @author ${USER}
 * @date ${DATE}
 */

重复上述步骤
打开 File and Code Templates 页面，选择 Methods 标签下的 Method，然后添加新的注释模板。

添加方法注释模板内容
在弹出的对话框中，输入以下内容：

/**
 * ${NAME}
 *
 * @param ${PARAM_NAME} ${PARAM_DESCRIPTION}
 * @return ${RETURN_TYPE}
 * @throws ${EXCEPTION_NAME} ${EXCEPTION_DESCRIPTION}
 */

点击 OK 保存。

假设你有一个方法名为 getUserInfo，按照上述步骤配置后，当你输入 getUserInfo 并按 Alt + Enter 时，IDEA会自动生成：

/**
 * getUserInfo
 *
 * @param id 用户ID
 * @return 用户信息
 * @throws RuntimeException 运行时异常
 */

重复上述步骤
打开 File and Code Templates 页面，选择 Variables 标签下的 Variable，然后添加新的注释模板。
添加变量注释模板内容
在弹出的对话框中，输入以下内容：
```
/**
 * ${NAME} ${变量的描述}
 */
```
点击 OK 保存。
使用变量注释模板
当你在变量名上按住 Alt + Enter 时，IDEA会自动插入你刚刚设置的注释模板。

假设你有一个变量名为 userInfo，按照上述步骤配置后，当你输入 userInfo 并按 Alt + Enter 时，IDEA会自动生成：

/**
 * userInfo 用户信息
 */

打开设置
在IDEA中，点击 File -> Settings（Windows/Linux）或 IntelliJ IDEA -> Preferences（Mac）。
导航到文件和代码模板
在设置窗口中，找到并点击 Editor -> File and Code Templates。
添加自定义模板
点击右侧的 + 按钮添加新的注释模板。
填写模板信息
在弹出的对话框中，输入模板的名称、缩写和内容：
- Template Name: 用户自定义名称
- Abbreviation: 用户自定义缩写
- Template Text: 用户自定义模板内容
点击 OK 保存。
使用自定义模板
在代码中输入模板的缩写，然后按 Tab 键，即可快速创建注释模板。

假设你创建了一个名为 CustomComment 的自定义注释模板，其缩写为 cc，内容如下：

/**
 * ${NAME}
 *
 * @param ${PARAM_NAME} ${PARAM_DESCRIPTION}
 * @return ${RETURN_TYPE}
 * @throws ${EXCEPTION_NAME} ${EXCEPTION_DESCRIPTION}
 */

当你输入 cc 并按 Tab 键时，IDEA会自动生成上述注释模板。

打开设置
在IDEA中，点击 File -> Settings（Windows/Linux）或 IntelliJ IDEA -> Preferences（Mac）。
导航到代码样式
在设置窗口中，找到并点击 Editor -> Code Style -> Java。
选择注释风格
在 Comments 选项卡中，选择你喜欢的注释风格，例如 Javadoc 或 HTML。
应用更改
点击 Apply 和 OK 保存更改。