天天看點

淺談Java開發規範--命名規範

    一個好的軟體,不單依賴于架構及項目管理,而且與代碼品質也息息相關。代碼品質取決于代碼的整潔度,整潔的代碼在軟體維護期、軟體更新過程中奠定了良好的基礎,如何才能寫出高品質代碼呢?高品質代碼好有很多方面的因數,命名規範是高品質代碼的開端也是一個重點,下面是我個人的一些見解,歡迎大家多多指教.         1.命名盡量做到名副其實。      很多人看到這個都說很簡單,這個問題一點都不簡單,好的方法、函數、變量、類的名稱已經答複使用者這個函數功能、如何使用等,如果需要注釋說明就說明你沒有做到名副其實,在軟體開發過程中做到這點是非常困難的,這個需要經驗的不斷積累和總結以及團隊之間的融合,一旦發現有的好的命名就替換掉舊的,這在軟體維護期會給你或閱讀你代碼的人帶來意想不到的驚喜。       例如:一個變量功能都一緻,表示使用者賬号,你看到:

String str="wilr"; //使用者  
           

      舒服,還是看到:

String account="wilr"; 
           

     舒服呢?我想大家都不言而喻吧。這隻是一個小小的例子,可能還不足夠說明問題,但是我相信看到這個小例子,大家都會明白以上所說的,是以我就不再舉例說明了。   2.避免不必要的錯誤     在軟體開發過程中,特别是大項目中,會存在很多的變量、方法、以及類,如果名稱相似,會導緻一些看起來莫名其妙但是非常幼稚的錯誤,這種錯誤本應該不存在的,這種錯誤也會給代碼維護、調試帶來不必要的工作量:     例如:      1.userPersistent和usersPersistent, userPersistent表示使用者持久化,usersPersistent表示使用者組持久化層,這2個持久化類,在開發過程中調用錯誤的幾率是不是非常大呢?這種錯誤會不會讓你覺得莫名奇妙呢?    3.命名區分    開發過程中,我們建立或者@Override一個方法的時候,編輯器會幫我們寫了一部分代碼,這些代碼一般都是沒有意義的,區分不明顯的,如C1、C2......看段代碼你就會明白我想表達的意思了,例如:

public void copyString(String str[],String str1[]){
		for (int i = 0; i <str.length; i++) {
			str1[i]=str[i];
		}
	}
           

    代碼中的str[]和str1[],這種區分你是否經常碰到呢?如果我這樣修改是不是看起來比較舒服了呢:

public void copyString(String source[],String target[]){
        for (int i = 0; i <source.length; i++) {
		target[i]=source[i];
	 }
  }
           

    高品質的代碼是我們不斷的追求,但切記不可一味的追求高品質,因為在實際開發中有一些問題是我們無法避免的,不要為了一個函數、類的名稱糾結很久很久耽誤了工期,耽誤工期的後果大家都懂的,在實際開發中要學會靈活變通,不斷的積累不斷的修改,會寫出高品質代碼的。    好了,由于時間關系,先寫到這裡,有空有想法再繼續。如果你有好的想法或者建議,歡迎留言。謝謝!