本文介绍了如何在Mac版的IntelliJ IDEA中设置类和方法的注释模板。通过设置，可以快速生成符合规范的注释，提高代码的标准化和可读性。类注释包含类名、描述、作者、日期和版权信息，方法注释则包含作者、方法描述、日期、参数和返回值。设置过程包括打开IDEA的偏好设置，选择文件和代码模板，编辑Class模板并保存。文章还展示了设置后的注释效果。
IDEA 类和方法注释模板设置（Mac版）
注释模板最终效果:
| 类注释模板: | 方法注释模板: |
| /** * @ClassName: BaseController * @Description: 公共服务接口 * @author 共享研发中心 * @date 8/8/21 12:14 PM * @version V1.0.0 * @Copyright: www.tcsn.vip All rights reserved. * 注意：本内容仅限于共享研发中心内部传阅，禁止外泄以及用于其他的商业目 */ | /** * @author 共享研发中心 * @Description: 用户登录 * @date 8/8/21 12:14 PM * @Param[args] * @return void */ |
- 设置类注释模板（IDEA中创建类时会自动添加注释）
打开IDEA，在最左侧菜单栏中点击Intellij IDEA，依次安装如下步骤进行：
- Intellij IDEA -> Preferences --> Editor --> File and Code Templates --> Files
- 选择Class文件(Interface文件和类文件设置方法相同)
- 拷贝下表中的类模板到内容区（详见截图）,然后点击保存即可
| /** * @ClassName: ${NAME} * @Description: TODO * @author 共享研发中心 * @date ${DATE} ${TIME} * @version V1.0.0 * @Copyright: www.tcsn.vip All rights reserved. * 注意：本内容仅限于共享研发中心内部传阅，禁止外泄以及用于其他的商业目 */ |
4.效果展示（在项目中新建一个类及真实完成后的注释效果
| 创建类自动生成后的效果: | 真实项目中使用的效果: |
|
|
|
4728
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
