首頁 > Java > java教程 > 主體

Java的命名規範

巴扎黑
發布: 2016-12-20 17:28:43
原創
1376 人瀏覽過

 在物件導向程式設計中,對於類,對象,方法,變數等方面的命名是非常有技巧的。例如,大小寫的區分,使用不同 字母開頭等等。但究其本,追其源,在為一個資源其名稱的時候,應該本著描述性以及唯一性這兩大特徵來命名,才能保證資源之間不衝突,並且每一個都便於記 憶。

包的命名  

  Java包的名字都是由小寫單字組成。但由於Java物件導向程式設計的特性,每位Java程式設計師都可以編寫屬於自己的Java包,為了保障每個Java包命名的唯一性,在最新的Java程式設計規範中,要求程式設計師在自己定義的包的名稱之前加上唯一的前綴。由於網路上的網域名稱是不會重複的,所以程式設計師一般會採用自己在網路上的網域名稱作為自己程式包的唯一前綴。
  例如: net.frontfree.javagroup

類的命名

   類別的名字必須由大寫字母開頭而單字中的其他字母均為小寫;如果類別名稱由多個單字組成,則每個單字的首字母開頭而單字中的其他字母均為小寫;如果類別名稱由多個單字組成,則每個單字的首字母開頭而單字應為大寫例如TestPage;如果類別名稱中包含單字縮寫,則這個所寫詞的每個字母都應大寫,如:XMLExample,還有一點命名技巧就是由於類別是設計用來代表物件的,所以在命名類時應盡量選擇名詞。   
  例如: Circle

方法的命名

  方法的名字的第一個單字應以小寫字母作為開頭,後面的單字則用大寫字母開頭。
  例如: sendMessge

常數的命名

  常數的名字應該都使用大寫字母,並且指出此常數完整意義。如果一個常數名稱由多個單字組成,則應該用底線來分割這些單字。
  例如: MAX_VALUE

參數的命名

  參數的命名規範和方法的命名規範相同,而且為了避免閱讀程序時造成迷惑,請在盡量保證參數名稱為一個單詞的情況下使參數的命名盡可能明確。

Javadoc註釋

  Java除了可以採用我們常見的註釋方式之外,Java語言規範還定義了一種特殊的註釋,也就是我們所說的Javadoc註釋,它是用來記錄我們程式碼中的API的。 Javadoc註解是一種多行註釋,以/**開頭,而以*/結束,註解可以包含一些HTML標記符和專門的關鍵字。使用Javadoc註釋 的好處是編寫的註釋可以自動轉為線上文檔,省去了單獨編寫程式文檔的麻煩。
  例如:

/**
* This is an example of
* Javadoc
*
* @author darchon
* @version 0.1, 10/11/2002
*/
登入後複製

  在每個程式的最開始部分,一般都用Javadoc註釋對程式的總體描述以及版權信息,之後在主程式中可以為每個類別、介面、方法、欄位添加Javadoc註釋,每個註釋的開頭部分先用一句話概括該類別、介面、方法、欄位所完成的功能,這句話應單獨佔據一行以突出其概括作用,在這句話後面可以跟隨更加詳細的描述段落。在描述性段落之後還可以跟隨一些以Javadoc註釋標籤開頭的特 殊段落,例如上面例子中的@auther和@version,這些段落將在生成文檔中以特定方式顯示。
  雖然為一個設計低劣的程序添加註釋不會使其變成好的程序,但是如果按照編程規範編寫程序並且為程序添加良好的註釋卻可以幫助你編寫出設計完美,運行效率高且易於理解的程序,尤其是在多人合作完成同一專案時編程規範就變得更加重要。俗話說“磨刀不誤砍柴工”,花一點時間去適應一下Java編程規範是有 好處的。


相關標籤:
來源:php.cn
本網站聲明
本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn
熱門教學
更多>
最新下載
更多>
網站特效
網站源碼
網站素材
前端模板
關於我們 免責聲明 Sitemap
PHP中文網:公益線上PHP培訓,幫助PHP學習者快速成長!