CodeStyle環境設置/檢查/使用手冊

序言

前提

本文面向軟件開發人員介紹EclipseCodeStyle的環境設置和使用方法,以及如何對CodeStyle做檢查。開發人員需要了解一些常見的軟件編碼規範(如SunJava語言編碼規範Eclipse的編碼規範)和Eclipse相關知識。

範圍

       本文將講述以下內容:

l         EclipseCodeStyle的環境設置

l         CodeStyle的使用方法

l         EclipseCheckStyle的安裝及設置

l         使用CheckStyle檢查CodeStyle  

概述

CodeStyle

       Eclipse中的CodeStyle爲軟件編碼提供了極大的方便。CodeStyle一般有3個功能:

l         Formatter,格式化代碼爲有序的格式,形成良好代碼風格;

l         Code Template,輔助生成模板代碼,提高編碼效率;

l         Clean Up,格式化代碼並清理或補全代碼的相關項,統一代碼風格;

我們可以通過設置CodeStyle的相關參數,做到滿足編碼規範的代碼風格統一。本文只對Java相關CodeStyle做介紹,JavaScript等的CodeStyle類似。

CheckStyle

       CheckStyle是非常優秀的代碼規範檢查工具,可以大幅的提高代碼質量,在團隊開發中經常用來檢查代碼風格是否統一,以及防範一些編碼中潛在的Bug

       目前,Eclipse中可用的CheckStyle插件有:EclipseCS  Checkclipse。我們選擇EclipseCS,可以在此下載到插件安裝包:http://eclipse-cs.sourceforge.net/

       結合CodeStyleCheckStyle的功能,很容易就能夠做到滿足編碼規範,代碼風格統一。

環境設置

CodeStyle設置

EclipseJavaCodeStyle默認使用的是EclipseProfile。根據項目需要可以導入自定義的Profile

導入自定義Clean Up Profile

打開Eclipse,選擇菜單【WindowPreferences】,選擇左樹節點【JavaCode StyleClean Up】並點擊【Import…】按鈕導入自定義Profile

CodeStyle環境設置/檢查/使用手冊 - dinstone - dinstone的IT農場
 

點擊【Apply…】按鈕應用該Profile

 

導入自定義Code Template Profile

打開Eclipse,選擇菜單【WindowPreferences】,選擇左樹節點【JavaCode StyleCode Templates】並點擊【Import…】按鈕導入自定義Profile

CodeStyle環境設置/檢查/使用手冊 - dinstone - dinstone的IT農場
 

點擊【Apply…】按鈕應用該Profile

注意:要將“Automatically and comments for newmethods and types”選中,否則生成文件時不會自動添加相關信息。

導入自定義Formatter Profile

打開Eclipse,選擇菜單【WindowPreferences】,選擇左樹節點【JavaCode StyleFormatter】並點擊【Import…】按鈕導入自定義Profile

CodeStyle環境設置/檢查/使用手冊 - dinstone - dinstone的IT農場
  

點擊【Apply…】按鈕應用該Profile

導入自定義Import Order Profile

打開Eclipse,選擇菜單【WindowPreferences】,選擇左樹節點【JavaCode StyleOrganize Imports】並點擊【Import…】按鈕導入自定義Profile

CodeStyle環境設置/檢查/使用手冊 - dinstone - dinstone的IT農場
 

點擊【Apply…】按鈕應用該Profile

CheckStyle設置

CheckStyle按裝

       打開Eclipse,選擇菜單【HelpInstall New Software…】,點擊【Add…】按鈕,輸入“Name”並選擇【Archive…】指定插件安裝包:

CodeStyle環境設置/檢查/使用手冊 - dinstone - dinstone的IT農場
 

然後選擇安裝。CheckStyle安裝成功後,在EclipsePreferences中能夠找到CheckStyle節點。

注意:其它安裝方式請參考相關文檔,這裏不在贅述。

導入自定義CheckStyle Profile

       打開Eclipse,選擇菜單【WindowPreferences】,選擇左樹節點【CheckStyle】。點擊【New…】按鈕創建一個新的CheckStyle

CodeStyle環境設置/檢查/使用手冊 - dinstone - dinstone的IT農場
 

首先選擇“Type”爲“External Configuration File”,然後輸入“Name”、“Description”,最後選擇本地自定義CheckStyle

注意:

l         請選中“Include rule names in violation messages”,這樣有利於速查到該違約的分類。

l         請選中“Protect Checkstyle configuration file”,這樣就能避免修改該配置文件。

使用說明

CodeStyle的使用

       通常,開發人員在編碼時會使用Eclipse相關的快捷鍵來輔助編碼以提高代碼質量和效率。如格式化代碼(Ctrl +Shift +F),添加Package ImportCtrl +Shift +M),去除多餘的引用Package ImportCtrl +Shift +O),添加JavaDocAlt + Shift + J)等。

一般在提交代碼之前,需要對整個工程中的Java代碼做CleanUp,以保證符合編碼規範。

選中要Clean Up的工程,選擇菜單【SourceClean Up…】:

CodeStyle環境設置/檢查/使用手冊 - dinstone - dinstone的IT農場
 

點擊【Next】,進入預覽頁面:

CodeStyle環境設置/檢查/使用手冊 - dinstone - dinstone的IT農場
 

左側的爲本地源代碼,右側爲重構後的代碼,點擊【finish】將應用重構後的代碼。

CheckStyle的使用

爲了保證整個團隊的代碼風格統一,需要對代碼做代碼風格檢查。通常開發人員在提交代碼之前,先對整個工程中的Java代碼執行CleanUp,然後使用Checkstyle來檢查代碼風格。

選中要檢查的工程,選擇菜單【ProjectProperties】,選中左樹節點【Checkstyle】:

CodeStyle環境設置/檢查/使用手冊 - dinstone - dinstone的IT農場
 

選中“Checkstyle active for this project”已激活CheckStyle檢查,選擇“CheckStyle-V1.0”作爲CheckStyleProfile。點擊【Ok】按鈕,啓動檢查。

       選擇菜單【WindowShow View】→【OtherProblems】,打開問題視圖:

CodeStyle環境設置/檢查/使用手冊 - dinstone - dinstone的IT農場
 

通常,將Errors級別的違約修改完了才能夠提交代碼。

參考文檔

1.         Eclipse-CS http://eclipse-cs.sourceforge.net/

2.         Checkstyle_4.3_中文手冊

發佈了28 篇原創文章 · 獲贊 12 · 訪問量 15萬+
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章