[TOC]
1 背景
本文意在將idea中的代碼格式和注釋格式進(jìn)行統(tǒng)一化纵刘。
研發(fā)團(tuán)隊(duì)的成員的代碼格式和注釋格式建議統(tǒng)一化蚤吹。
統(tǒng)一的代碼格式和注釋格式，能給代碼閱讀上帶來(lái)極大的便利，給代碼改動(dòng)上提高極大的效率锨推。
1.1 開(kāi)發(fā)工具
idea
1.2 代碼格式化模板
阿里格式化模板
1.3 注釋模板
（1）類模板樣例
/**
* （自定義類描述）
* @author zhangsan
* @date 2020/09/08 08:23
**/
public class MyTest {
}
（2）方法模板樣例
/**
* （自定義方法描述）
* @author zhangsan
* @date 2020/09/07 20:07
* @param message
* @param name
* @return java.lang.String
*/
public String myTest(String message,String name){
return "";
}
無(wú)參方法铅歼，將不生成@param參數(shù)：
/**
* （自定義方法描述）
* @author zhangsan
* @date 2020/09/08 08:02
* @return java.lang.String
*/
public String myTest(){
return "";
}
2 下載模板文件
阿里模板下載地址
https://github.com/alibaba/p3c/tree/master/p3c-formatter
下載如下兩個(gè)模板文件（鏈接為下載頁(yè)面）：
代碼格式（用于代碼格式化）：eclipse-codestyle.xml
代碼模板（代碼注釋模板，IDEA中無(wú)法使用）：eclipse-codetemplate.xml
3 IDEA代碼格式化
因阿里提供的代碼格式化配置是基于eclipse的换可，如需在idea中使用此配置椎椰，需要安裝對(duì)應(yīng)的eclipse插件。
3.1 安裝插件
阿里配置文件是針對(duì)ecplice的沾鳄，在IDE中慨飘，所有的配置文件導(dǎo)入，需要安裝Eclipse Code Formatter插件译荞。
3.2 配置代碼格式
File->Settings->Other Settings->Eclipse Code Formatter進(jìn)行idea代碼格式配置：
將代碼格式化文件eclipse-codestyle.xml瓤的，配置到插件中：
3.3 使用
（1）格式化部分代碼
選中需要格式化的代碼，快捷鍵：ctrl+alt+L
（2）格式化整個(gè)文件
在需要格式化的文件中吞歼，快捷鍵：ctrl+alt+L
（3）格式化整個(gè)項(xiàng)目（慎用）
idea中圈膏，項(xiàng)目上右鍵->Reformat Code
如已經(jīng)存在的項(xiàng)目初次使用統(tǒng)一的代碼格式化，建議在一個(gè)時(shí)間點(diǎn)將整個(gè)項(xiàng)目統(tǒng)一進(jìn)行一次代碼格式化篙骡。避免單獨(dú)的格式化稽坤，導(dǎo)致部分研發(fā)人員的代碼合并出現(xiàn)嚴(yán)重沖突。
4 IDEA代碼注釋配置
4.1 配置全局中USER
在此配置全局USER糯俗，用于填充自動(dòng)生成的注釋中的作者@author屬性尿褪。
Help->Edit Custom VM Options...
增加如下配置：
-Duser.name=xxx
4.2 配置類注釋模板
settings->Editor->File and Code Templates->files->class
增加注釋模板：
/**
* ${description}
* @author ${USER}
* @date ${YEAR}/${MONTH}/${DAY} ${HOUR}:${MINUTE}
**/
模板增加后，如下（注釋上方的換行符必須有）：
#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
* ${description}
* @author ${USER}
* @date ${YEAR}/${MONTH}/${DAY} ${HOUR}:${MINUTE}
**/
public class ${NAME} {
}
新創(chuàng)建java文件時(shí)得湘，會(huì)提示輸入類描述description杖玲，生成的文件格式如下：
package com.test;
/**
* 我的測(cè)試類
* @author zhangsan
* @date 2020/09/08 10:23
**/
public class MyTest {
}
4.3 配置方法注釋
4.3.1 配置流程
Editor->Live Template->java
新建Live Template，進(jìn)行如下配置：
第5步淘正，適用場(chǎng)景配置如下：
第6步摆马，模板變量配置如下：
4.3.2 配置參數(shù)
（1）模板配置
配置如下：
縮寫Abbreviation：
*
模板Template text：
*
*
* @author $user$
* @date $data$ $time$$param$
* @return $return$
*/
（2）變量配置
user：
user()
date：
date("yyyy/MM/dd")
time：
time("HH:mm")
param：
groovyScript("if(\"${_1}\".length() == 2) {return '';} else {def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList();for(i = 0; i < params.size(); i++) {result+='\\n' + ' * @param ' + params[i] + ' '}; return result;}", methodParameters());
return：
methodReturnType()
4.3.3 使用
在java方法上輸入/**后，按下tab鍵跪帝，即可在方法上方生成方法注釋今膊，如下：
/**
* （①方法描述）
* @author zhangsan
* @date 2020/09/07 20:07
* @param message （②參數(shù)描述）
* @param name （②參數(shù)描述）
* @return java.lang.String （③返回值描述）
*/
public String myTest(String message,String name){
return "";
}
依次填寫：
①方法描述
②參數(shù)描述
③返回值描述
4.3.2 注意事項(xiàng)
（1）為避免對(duì)變量注釋時(shí)的影響，變量的注釋仍然采用默認(rèn)的注釋方式：/**+回車伞剑，生成的注釋仍然是默認(rèn)注釋：
/**
*
*/
private String userName;
（2）無(wú)參方法斑唬，將不生成@param參數(shù)：
/**
*
* @author zhangsan
* @date 2020/09/08 08:02
* @return java.lang.String
*/
public String myTest(){
return "";
}
4.4 補(bǔ)充（關(guān)于類注釋）
4.2中，配置的類注釋模板黎泣，需要在創(chuàng)建類的時(shí)候恕刘，才可以生成類注釋。對(duì)于拷貝過(guò)來(lái)的類文件抒倚，或者已經(jīng)存在的類文件褐着，無(wú)法加上對(duì)應(yīng)注釋。
因此托呕，可以參照4.3含蓉，進(jìn)行代碼模板配置频敛。
4.4.1 配置流程
其中的5 適用場(chǎng)景同4.3.1：
4.4.2 配置參數(shù)
（1）模板配置
配置如下：
縮寫Abbreviation：
cc
模板Template text：
/**
*
* @author $user$
* @date $date$ $time$
**/
（2）變量配置
user：
user()
date：
date("yyyy/MM/dd")
time：
time("HH:mm")
description：
不配置
4.4.3 使用
在類上輸入cc后，按下回車鍵馅扣，即可在方法上方生成類注釋斟赚，如下：
/**
* （①類描述）
* @author zhangsan
* @date 2020/09/08 08:21
**/
public class MyTest {
}
填寫：
①類描述
