后端代码注释设置

后端代码注释设置

为了更良好的代码观赏体验，希望大家能统一代码注释风格，如有不同意见欢迎积极交流。

代码注释规范

• 接口方法（抽象方法）必须有方法注释，且方法描述，方法参数描述，方法返回值，异常信息不能空着不写。
• 类必须有类注释，且类的描述不能为空
• 方法内类关键代码逻辑需要有必要的注释说明
• 禁止使用行尾注释

注释模板

类注释

模板：

/**
 * 类名
 *
 * @author 
 * @version 1.0.0
 * @description 
 * @date 
 */

示例：

/**
 * BillController
 *
 * @author lky
 * @version 1.0.0
 * @description 税务管理接口
 * @date 2021/10/9 13:18
 */

方法注释

模板：

/**
 * 方法名
 *
 * @param query 
 * @return 
 * @description 
 * @author 
 * @date 
 * @version 1.0.0
 */

示例：

/**
 * feeQuery
 *
 * @param query 运单号、分段分单号、收款人身份证号
 * @return 需缴款信息
 * @description 查询运单开票缴款金额
 * @author sh
 * @date 2021/10/14 16:22
 * @version 1.0.0
 */

IDEA注释设置

类注释修改

点击IDEA中的Settings —> Editor —> File and Code Templates选择class，如下图，然后输入类注释模板，将开发者名字修改为自己的名字的简拼或者全拼。

类文件注释模板内容：

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
 * ${NAME}
 *
 * @author lky
 * @version 1.0.0
 * @description 
 * @date ${DATE} ${TIME}
 */
public class ${NAME} {
}

方法注释修改

第一步：新建自定义Template Group，可以取名为userDefine如下图：

第二步：新建在上述新建组上，点击右侧的+号新建Live Template，结果如下图：

注意Template text框中的格内格式

Template Text内容如下：

*
 * $methodName$
 *
 * @description
 $param$
 * @return 
 * @author luokangyuan
 * @date $date$ $time$
 * @version 1.0.0
 */

第三步：修改注释参数，点击EDIT VARIABLES按钮，修改结果如下图：

其中param参数的Default value值如下：

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {if(i==0){result+='* @param ' + params[i] + ((i < params.size() - 1) ? '\\n' : '')}else{result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\n' : '')}}; return result", methodParameters())

使用方法

• 类注释直接在新建类的时候会自动添加上
• 方法注释需要在方法体上输入/**后按Enter键即可生成