Android開發中java
命名規則包的命名
Java包的名字都是由小寫單片語成。但是由於Java物件導向編程的特性,每一名Java程式員都可以編寫屬於自己的Java包,為了保障每個Java包命名的唯一性,在最新的Java編程規範中,要求程式員在自己定義的包的名稱之前加上唯一的首碼。由於互連網上的網域名稱稱是不會重複的,所以程式員一般採用自己在互連網上的網域名稱稱作為自己程式包的唯一首碼。
例如: net.frontfree.javagroup
包劃分及命名規則:
java代碼:
com.mycompany.util
com.mycompany.myproject
com.mycompany.myproject.util
com.mycompany.myproject.model
com.mycompany.myproject.dao
com.mycompany.myproject.dao.ejb
com.mycompany.myproject.dao.hibernate
com.mycompany.myproject.service
com.mycompany.myproject.service.impl
com.mycompany.myproject.webapp.action
com.mycompany.myproject.webapp.filter
com.mycompany.myproject.webapp.listener
com.mycompany.myproject.webapp.taglib
類的命名
類的名字必須由大寫字母開頭而單詞中的其他字母均為小寫;如果類名稱由多個單片語成,則每個單詞的首字母均應為大寫例如TestPage;如果類名稱中包含單詞縮寫,則這個所寫詞的每個字母均應大寫,如:XMLExample,還有一點命名技巧就是由於類是設計用來代表對象的,所以在命名類時應盡量選擇名詞。
例如: Circle
方法的命名
方法的名字的第一個單詞應以小寫字母作為開頭,後面的單詞則用大寫字母開頭。
例如: sendMessge
常量的命名
常量的名字應該都使用大寫字母,並且指出該常量完整含義。如果一個常量名稱由多個單片語成,則應該用底線來分割這些單詞。
例如: MAX_VALUE
參數的命名
參數的命名規範和方法的命名規範相同,而且為了避免閱讀程式時造成迷惑,請在盡量保證參數名稱為一個單詞的情況下使參數的命名儘可能明確。
Javadoc注釋
Java除了可以採用我們常見的注釋方式之外,Java語言規範還定義了一種特殊的注釋,也就是我們所說的Javadoc注釋,它是用來記錄我們代碼中的API的。Javadoc注釋是一種多行注釋,以結束,注釋可以包含一些HTML標記符和專門的關鍵詞。使用Javadoc注釋的好處是編寫的注釋可以被自動轉為線上文檔,省去了單獨編寫程式文檔的麻煩。
在每個程式的最開始部分,一般都用Javadoc注釋對程式的總體描述以及著作權資訊,之後在主程式中可以為每個類、介面、方法、欄位添加Javadoc注釋,每個注釋的開頭部分先用一句話概括該類、介面、方法、欄位所完成的功能,這句話應單獨佔據一行以突出其概括作用,在這句話後面可以跟隨更加詳細的描述段落。在描述性段落之後還可以跟隨一些以Javadoc注釋標籤開頭的特殊段落,例如上面例子中的@auther和@version,這些段落將在產生文檔中以特定方式顯示。
雖然為一個設計低劣的程式添加註釋不會使其變成好的程式,但是如果按照編程規範編寫程式並且為程式添加良好的注釋卻可以協助你編寫出設計完美,運行效率高且易於理解的程式,尤其是在多人合作完成同一項目時編程規範就變得更加重要。俗話說“磨刀不誤砍柴工”,花費一點時間去適應一下Java編程規範是有好處的。