在項目開發維護中,編碼規範做爲開發規範的一個組成部分,是十分重要和必須的,它不單單是爲了提升開發效率,也有利於下降後期維護開發的成本。編碼規範的根本目的就是要讓不只代碼能夠一目瞭然,也能夠很容易的理解開發人員所編寫的代碼程的用途和意義。由此,用來減小項目中由於開發維護人員的更替或因爲長時間不維護形成的記憶模糊或混亂等狀況帶來的對代碼所實現的真正功能的理解困難和歧義。另外也提升了代碼複查效率和效果。java
第一章Eclipse配置windows
1.1 codeformat和codetemplates導入app
模板導入操做以下,codeformat:eclipse
一、 打開eclipse,選擇windows->preferences->java->Code Style->Formatter編碼
二、 選擇Import…,而後選擇codeformat.xml文件,插件
三、 最後選擇apply,codetemplates操做也一樣操做便可。code
1.2 checkstyleorm
checksyle須要先安裝eclipse插件,具體操做以下:xml
一、 打開eclipse,選擇help->eclipse Marketplace,而後搜索checkstyle安裝便可;ip
二、 完成安裝重啓eclipse後,選擇windows->preferences->Checkstyle
三、 最後選中剛剛導入的這條數據,「set as Default」就設置完成了
第二章使用
2.1 codeformat和codetemplates
一、 codeformat模板導入完成後,直接在打開的文件中使用「shift+ctrl+f」快捷鍵就能夠格式化代碼格式了。若是不生效,確定是快捷鍵被其餘程序佔用了,我電腦上就是被sogou輸入法佔用,去掉輸入法中的快捷鍵就好了。
二、 codetemplates導入完成後,直接在類的聲明處、方法聲明處敲入「/**」,而後敲「回車」,就自動生成了註釋模板格式。
2.2checkstyle
一、 選中項目工程,右鍵選擇Checkstyle->Check Code with Checkstyle,就會自動檢查項目樣式,也能夠選中某個已經打開的文件作此操做
二、 一樣的操做,選擇Clear Checkstyle violations取消檢查。
三、 檢查完成後,打開文件就會提示不合規項(鼠標放在行號邊上的放大鏡上或者提示的這行代碼上,就能夠看到詳細描述),修改後再從新檢查便可。
另外還能夠配合SonarQube使用,後面文章將會介紹。