2020版IDEA项目注释规范设置

前言

编码规范,代表了我们的编码风格,在企业里面是很重要的,比如注释规范,现在我们来看看最新版(阿里巴巴编码手册-泰山版)

  1. 【强制】类、类属性、类方法的注释必须使用 Javadoc 规范,使用/*内容/格式,不得使用
    // xxx 方式。

一、类注释

/**
 * @description: TODO
 * @author: ydf
 * @date: ${DATE} ${TIME}
 * @version: v1.0
 */

可根据实际需求更改,修改成功之后可能不生效,重启idea即可
在这里插入图片描述
测试如下:
在这里插入图片描述

二、方法注释

2.1 新建template group:
在这里插入图片描述
2.2 自定义命名:
在这里插入图片描述
2.3 创建template:
在这里插入图片描述
2.4 设置template格式:
在这里插入图片描述
2.5 设置模板参数:
在这里插入图片描述
在这里插入图片描述
2.6 设置模板的应用场景
在这里插入图片描述
点击模板页面最下方的警告,来设置将模板应用于那些场景,一般选择EveryWhere–>Java即可
在这里插入图片描述
使用测试:创建方法,在方法上面写:// 回车即可
在这里插入图片描述

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章