IDEA提交代码被老板吐槽?这个Author设置坑,你可能踩了10年!

以下是为IntelliJ IDEA设计的 ‌高可用注释模板‌ ,涵盖方法、类、字段注释,支持自动参数提取和版本追踪,可直接复制使用:


🔧 ‌IDEA注释模板配置步骤

  1. 打开设置‌:File → Settings → Editor → File and Code Templates
  2. 选择作用域‌:配置Files(类/文件注释)或Code(方法注释)标签页
  3. 粘贴模板‌:将下方模板粘贴到对应区域(如Class/Interface/Enum等)
  4. 启用自动生成‌:勾选Enable Live Templates

📝 ‌注释模板代码

1. ‌类/文件注释模板‌(Files标签页)
/**
 * @ClassName ${NAME}
 * @Description ${TODO}(用一句话描述类的作用)
 * @Author ${USER}
 * @Date ${DATE} ${TIME}
 * @Version 1.0
 * @History <pre>
 * <修改记录>
 *  <version>  <date>  <author>  <desc> 
 *  1.0    ${DATE} ${TIME}  ${USER}  新建
 * </修改记录>
 * </pre>
 */
2. ‌方法注释模板‌(Live Templates)

模板名称‌:*(触发关键词,需在Abbreviation中设置)
模板内容‌:

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

变量配置‌:

  • param脚本(自动提取参数):
groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\$|\\\$|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+=' * @Param ' + params[i] + ((i < params.size() - 1) ? '\\n' : '')}; return result", methodParameters())
  • return脚本(自动匹配返回值):
groovyScript("def returnType = \"${_1}\"; return returnType == 'void' ? '无' : returnType;", methodReturnType())
3. ‌字段注释模板
/** 
 * @Description ${TODO}
 * @Author ${USER}
 * @Date ${DATE} ${TIME}
 * @Version 1.0
 */
private String demoField;

🌟 ‌效果演示

生成类注释:
/**
 * @ClassName UserService
 * @Description 用户管理核心业务类
 * @Author ZhangSan
 * @Date 2024-02-20 14:30
 * @Version 1.0
 * @History <pre>
 *  <修改记录>
 *   <version>  <date>     <author>  <desc> 
 *   1.0    2024-02-20  ZhangSan  新建
 *  </修改记录>
 * </pre>
 */
生成方法注释:
/**
 * @Description 根据ID查询用户信息
 * @Param userId
 * @Param isDetail
 * @return UserDTO
 * @throws BusinessException 
 * @Author ZhangSan
 * @Date 2024-02-20 14:35
 */
public UserDTO getUserById(Long userId, Boolean isDetail) throws BusinessException {
    // ...
}

⚙️ ‌高级配置技巧

  1. 自动获取Git用户名‌:
    Settings → Appearance & Behavior → Path Variables中绑定USER变量到Git全局用户名。也可以在Help → Edit custom VM Options...增加参数,并重启IDEA生效。

    
    -Duser.name=zhangsan
  2. 版本自动递增‌:
    在模板中使用#set($version = 1.0)配合版本管理插件(如Git)。

  3. 团队统一模板‌:
    导出配置:File → Manage IDE Settings → Export Settings,勾选File and Code Templates


📌 ‌最佳实践建议

  • @Description的默认值${TODO}设置为红色高亮,避免遗忘补充
  • 对核心业务代码启用@throws异常说明
  • 在字段注释中标注敏感字段(如@Encrypt
  • 使用@History块记录重大逻辑变更

提示‌ :模板变量(如${DATE})需确保已启用Enable Live Templates,若需要更复杂的逻辑(如自动生成版本号),可结合Groovy脚本扩展。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值