java-idea-編碼規範

jdk版本一般爲jdk8,編碼工具統一使用idea

1 配置類文件頭註釋模版

點擊IDEA編譯器左上角的“IntelliJ IDEA”按鈕,選擇“Preferences…”,在彈出窗口中,選擇“Editor–>File and Code Templates”,在窗口的右邊“Schema”下拉欄選擇“Default”,然後點擊“Includes”標籤,在右邊模版欄中填寫註釋模版。最後點擊右下角OK按鈕生效
參考內容如下:

/**
* description: TODO
* @date: ${DATE} ${TIME}
* @author: wanjinyu(改爲自己的郵箱前綴名)
*/

參考截圖如下:
在這裏插入圖片描述

2 配置方法頭註釋模版

點擊IDEA編譯器左上角的“IntelliJ IDEA”按鈕,選擇“Preferences…”,在彈出窗口中,選擇“Editor–>Live Templates”,進入方法頭註釋模版編輯界面

2.1 新建一個template group ,我這裏起的名字是 bjhlTemplates

在這裏插入圖片描述

2.2 新建一個live template ,配置詳細信息

在這裏插入圖片描述
注意配置這些信息:
在這裏插入圖片描述
Template Text 內容如下:

*
 * description: TODO
 * @date: $date$ $time$
 * @author: wanjinyu(改爲自己的郵箱前綴名)
$params$
 * @return TODO
 */ 

點擊“Edit variables”,配置參數,截圖如下:
在這裏插入圖片描述
params表達式內容: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())

右鍵點擊“方法註釋”,選擇“change context……” ,然後選中“Java”即可
在這裏插入圖片描述
在這裏插入圖片描述
完成後確認ok

3 驗證“類文件頭註釋模版”和“方法頭註釋模版”是否完成

3.1 新建一個class文件,看class頭註釋是否生成:

在這裏插入圖片描述

3.2 在該類中任意寫一個方法,然後 敲入 /** +回車鍵,看是否生成方法註釋:

在這裏插入圖片描述
如果2個都ok,說明配置成功

4 Google Code Style配置

在配置菜單中搜索code style,點選Java,在右側點Manege配置google code style

google code style的xml文件下載地址: https://github.com/google/styleguide/blob/gh-pages/intellij-java-google-style.xml
將xml文件導入,然後選中GoogleStyle。
在這裏插入圖片描述
說明:1)在Code Style主菜單項中Right Margin的Wrap on typing需要勾選,並且在Code Style->java->Wrapping and Braces中需要勾選Ensure right margin is not exceeded,這兩個勾選之後可以保證代碼不會超過右邊的邊界線
在這裏插入圖片描述
在這裏插入圖片描述
2)在Code style->java->Tabs and Indents中continuation indent需要填寫2,這表示當一行超出邊界換行時前面的縮進大小

在這裏插入圖片描述

5 save actions配置

在配置菜單中搜索Plugins,在右側選擇Browse repositories,搜索save actions,選擇安裝
在這裏插入圖片描述
在這裏插入圖片描述

下載該插件之後進入Other settings->save action,勾選截圖中的選項,這樣Java文件會以google code style的風格自動格式化並且去除無用import包。
可以新建一個文件或者修改一個文件,加幾個空格,保存後看格式變沒,變了表示設置好了

在類中加入這行代碼
private static final String TEST_ONE_HUNDRED =“11111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111”;

save之後,看看是不是改成

private static final String TEST_ONE_HUNDRED =
“11111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111”;
6. 阿里規約插件(可選)
安裝方式參考: https://jingyan.baidu.com/article/75ab0bcb75beced6864db2b1.html
不做強制要求,可以參考規約的建議調整代碼

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