復(fù)雜的故事簡(jiǎn)單說截粗，復(fù)雜的問題簡(jiǎn)單做信姓，您好，這里是簡(jiǎn)露一手绸罗，歡迎瀏覽意推。
簡(jiǎn)述
經(jīng)常：提交代碼到SVN比對(duì)，發(fā)現(xiàn)代碼被上一個(gè)提交的人整體格式化了珊蟀，差異無法比對(duì)菊值，提交后將別人代碼覆蓋，自己代碼也被人覆蓋育灸。
時(shí)常：不熟悉項(xiàng)目或新人加入項(xiàng)目腻窒，新代碼怎么都顯得格格不入，說它的不對(duì)還沒什么依據(jù)磅崭。
最后：代碼樣式儿子、函數(shù)命名千奇百怪，偉大了一堆填坑的人绽诚。
分析
對(duì)于項(xiàng)目研發(fā)管理上典徊，積累越多杭煎，問題越凸顯。這個(gè)問題簡(jiǎn)單列出就兩點(diǎn)：
- 缺少統(tǒng)一格式標(biāo)準(zhǔn)
- 缺少檢測(cè)機(jī)制
處理的方式很多卒落，這里就推薦一種羡铲。統(tǒng)一格式用Eclipse里面Formatter和CodeTemplate；檢測(cè)機(jī)制則推薦使用Eclipse 插件“checkStyle”儡毕。
處理
分三個(gè)步驟處理也切，分別是Formatter、CodeTemplate和CheckStyle的處理腰湾。
Formatter
Formatter我們用它定義代碼格式雷恃，這個(gè)代碼格式就包括變量命名、方法命名费坊、方法行數(shù)倒槐，縮進(jìn)字符數(shù)等格式，當(dāng)然最簡(jiǎn)單的辦法還是直接找一個(gè)模板附井，添加到eclipse中讨越，要對(duì)現(xiàn)有模板進(jìn)行修改，則點(diǎn)擊“Edit”修改模板格式永毅，修改后的格式記得導(dǎo)出給他人使用把跨，以便保持所有人格式統(tǒng)一。
CodeTemplate
CodeTemplate我們用來定義類沼死、方法和變量的備注着逐，也就是JavaDoc，類JavaDoc一般定義一個(gè)公司版權(quán)意蛀、創(chuàng)建時(shí)間和路徑耸别；方法JavaDoc、變量JavaDoc定義入?yún)⒔洹⒊鰠⒏袷竭€有創(chuàng)建人太雨、UR等信息。最簡(jiǎn)單的辦法：找一個(gè)現(xiàn)有模板魁蒜，修改版權(quán)信息后導(dǎo)入到Eclipse中囊扳，要對(duì)現(xiàn)有模板修改，則點(diǎn)擊“Edit”修改模板格式兜看，修改后的格式記得導(dǎo)出給他人使用锥咸，以便保持所有人格式統(tǒng)一。
CheckStyle
checkStyle我們用它來做檢測(cè)细移，檢測(cè)代碼格式是否符合標(biāo)準(zhǔn)搏予。所以我們需要編寫一個(gè)checkstyle格式文件，然后在Eclipse中用格式文件去進(jìn)行代碼格式校驗(yàn)弧轧。
-
格式文件
CheckStyle 格式文件編寫雪侥，最簡(jiǎn)單的辦法還是直接找一個(gè)CheckStyle模板碗殷，如果符合要求直接使用，不符合的地方做稍微調(diào)整速缨，如果想對(duì)checkstyle全面了解锌妻，可以搜“checkstyle檢查規(guī)則”
checkstyle檢查規(guī)則 安裝使用
CheckStyle非Eclipse自帶，需要安裝插件旬牲，在百度上搜索“checkstyle安裝”能找到N種安裝的方式仿粹。
效果展示
-
格式與標(biāo)準(zhǔn)不符時(shí)，CheckStyle會(huì)自動(dòng)標(biāo)紅原茅，告訴你哪里不對(duì)吭历。
checkStyle校驗(yàn) -
按Ctrl+Shift+F 自動(dòng)按照標(biāo)準(zhǔn)格式化代碼，按Alt+Shift+J自動(dòng)生成方法的JavaDoc擂橘，CheckStyle標(biāo)紅處會(huì)消失晌区。
自動(dòng)格式化
總結(jié)
定義Formatter、CodeTemplate贝室，設(shè)置CheckStyle契讲，好幫手、高質(zhì)量滑频、事半功倍，從這里開始唤冈。
<small>貼不了附件峡迷，需要Formatter、CodeTemplate你虹、CheckStyle三個(gè)模板绘搞，請(qǐng)留言留下郵箱</small>
