java中表示根号三_Java命名规范
定義規(guī)范的目的是為了使項目的代碼樣式統(tǒng)一,使程序有良好的可讀性。
包的命名 (全部小寫,由域名定義)
Java包的名字都是由小寫單詞組成。但是由于Java面向?qū)ο缶幊痰奶匦?#xff0c;每一名Java程序員都 可以編寫屬于自己的Java包,為了保障每個Java包命名的唯一性,在最新的Java編程規(guī)范中,要求程序員在自己定義的包的名稱之前加上唯一的前綴。 由于互聯(lián)網(wǎng)上的域名稱是不會重復(fù)的,所以程序員一般采用自己在互聯(lián)網(wǎng)上的域名稱作為自己程序包的唯一前綴。
例如:net.frontfree.javagroup
類的命名 (單詞首字母大寫)
根據(jù)約定,Java類名通常以大寫字母開頭,如果類名稱由多個單詞組成,則每個單詞的首字母均應(yīng)為大 寫例如TestPage;如果類名稱中包含單詞縮寫,則這個所寫詞的每個字母均應(yīng)大寫,如:XMLExample,還有一點命名技巧就是由于類是設(shè)計用來 代表對象的,所以在命名類時應(yīng)盡量選擇名詞。
例如: Graphics
方法的命名(首字母小寫,字母開頭大寫)
方法的名字的第一個單詞應(yīng)以小寫字母作為開頭,后面的單詞則用大寫字母開頭。
例如:drawImage
常量的命名 (全部大寫 ,常加下劃線)
常量的名字應(yīng)該都使用大寫字母,并且指出該常量完整含義。如果一個常量名稱由多個單詞組成,則應(yīng)該用下劃線來分割這些單詞。
例如:MAX_VALUE
參數(shù)的命名
參數(shù)的命名規(guī)范和方法的命名規(guī)范相同,而且為了避免閱讀程序時造成迷惑,請在盡量保證參數(shù)名稱為一個單詞的情況下使參數(shù)的命名盡可能明確。
Javadoc注釋
Java除了可以采用我們常見的注釋方式之外,Java語言規(guī)范還定義了一種特殊的注釋,也就是我們 所說的Javadoc注釋,它是用來記錄我們代碼中的API的。Javadoc注釋是一種多行注釋,以/**開頭,而以*/結(jié)束,注釋可以包含一些 HTML標(biāo)記符和專門的關(guān)鍵詞。使用Javadoc 注釋的好處是編寫的注釋可以被自動轉(zhuǎn)為在線文檔,省去了單獨(dú)編寫程序文檔的麻煩。
例如:
/**
* This is an example of
* Javadoc
* @author darchon
* @version 0.1, 10/11/2002
*/
在每個程序的最開始部分,一般都用Javadoc注釋對程序的總體描述以及版權(quán)信息,之后在主程序中 可以為每個類、接口、方法、字段添加 Javadoc注釋,每個注釋的開頭部分先用一句話概括該類、接口、方法、字段所完成的功能,這句話應(yīng)單獨(dú)占據(jù)一行以突出其概括作用,在這句話后面可以跟 隨更加詳細(xì)的描述段落。在描述性段落之后還可以跟隨一些以Javadoc注釋標(biāo)簽開頭的特殊段落,例如上面例子中的@auther和@version,這 些段落將在生成文檔中以特定方式顯示。
變量的命名
主要的的命名規(guī)范有以下三種:
Camel 標(biāo)記法:首字母是小寫的,接下來的單詞都以大寫字母開頭
Pascal 標(biāo)記法:首字母是大寫的,接下來的單詞都以大寫字母開頭
匈牙利標(biāo)記法:在以Pascal標(biāo)記法的變量前附加小寫序列說明該變量的類型
在Java我們一般使用匈牙利標(biāo)記法,基本結(jié)構(gòu)為scope_typeVariableName,它 使用1-3字符前綴來表示數(shù)據(jù)類型,3個字符的前綴必須小寫,前綴后面是由表意性強(qiáng)的一個單詞或多個單詞組成的名字,而且每個單詞的首寫字母大寫,其它字 母小寫,這樣保證了對變量名能夠進(jìn)行正確的斷句。例如,定義一個×××變量,用來記錄文檔數(shù)量:intDocCount,其中int表明數(shù)據(jù)類型,后面為表 意的英文名,每個單詞首字母大寫。這樣,在一個變量名就可以反映出變量類型和變量所存儲的值的意義兩方面內(nèi)容,這使得代碼語句可讀性強(qiáng)、更加容易理解。 byte、int、char、long、float、 double、boolean和short。
數(shù)據(jù)類型/前綴(附)
byte b
char c
short sh
int i
long l
char c
string s
float f
double d
hashtable h
[] arr
List lst
Vector v
StringBuffer sb
Boolean b
Byte bt
Map map
Object ob
對于在多個函數(shù)內(nèi)都要使用的全局變量,在前面再增加“g_”。例如一個全局的字符串變量:g_strUserInfo。
在變量命名時要注意以下幾點:
· 選擇有意義的名字,注意每個單詞首字母要大寫。
· 在一段函數(shù)中不使用同一個變量表示前后意義不同的兩個數(shù)值。
· i、j、k等只作為小型循環(huán)的循環(huán)索引變量。
· 避免用Flag來命名狀態(tài)變量。
· 用Is來命名邏輯變量,如:blnFileIsFound。通過這種給布爾變量肯定形式的命名方式,使得其它開發(fā)人員能夠更為清楚的理解布爾變量所代表的意義。
· 如果需要的話,在變量最后附加計算限定詞,如:curSalesSum。
· 命名不相包含,curSales和curSalesSum。
· static final 變量(常量)的名字應(yīng)該都大寫,并且指出完整含義。
· 如果需要對變量名進(jìn)行縮寫時,一定要注意整個代碼中縮寫規(guī)則的一致性。例如,如果在代碼的某些區(qū)域中使用intCnt,而在另一些區(qū)域中又使用intCount,就會給代碼增加不必要的復(fù)雜性。建議變量名中盡量不要出現(xiàn)縮寫。
· 通過在結(jié)尾處放置一個量詞,就可創(chuàng)建更加統(tǒng)一的變量,它們更容易理解,也更容易搜索。例如,請使用 strCustomerFirst和strCustomerLast,而不要使用strFirstCustomer和strLastCustomer。常 用的量詞后綴有:First(一組變量中的第一個)、Last(一組變量中的最后一個)、Next(一組變量中的下一個變量)、Prev(一組變量中的上 一個)、Cur(一組變量中的當(dāng)前變量)。
· 為每個變量選擇最佳的數(shù)據(jù)類型,這樣即能減少對內(nèi)存的需求量,加快代碼的執(zhí)行速度,又會降低出錯的可能性。用于變量的數(shù)據(jù)類型可能會影響該變量進(jìn)行計算所產(chǎn)生的結(jié)果。在這種情況下,編譯器不會產(chǎn)生運(yùn)行期錯誤,它只是迫使該值符合數(shù)據(jù)類型的要求。這類問題極難查找。
· 盡量縮小變量的作用域。如果變量的作用域大于它應(yīng)有的范圍,變量可繼續(xù)存在,并且在不再需要該變量后的很長時間內(nèi)仍然占用資源。它們的主要問題是,任何類 中的任何方法都能對它們進(jìn)行修改,并且很難跟蹤究竟是何處進(jìn)行修改的。占用資源是作用域涉及的一個重要問題。對變量來說,盡量縮小作用域?qū)?yīng)用程序的 可靠性產(chǎn)生巨大的影響。
關(guān)于常量的命名方法,在JAVA代碼中,無論什么時候,均提倡應(yīng)用常量取代數(shù)字、固定字符串。也就是 說,程序中除0,1以外,盡量不應(yīng)該出現(xiàn)其他數(shù)字。常量可以集中在程序開始部分定義或者更寬的作用域內(nèi),名字應(yīng)該都使用大寫字母,并且指出該常量完整含 義。如果一個常量名稱由多個單詞組成,則應(yīng)該用下劃線“_”來分割這些單詞如:NUM_DAYS_IN_WEEK、MAX_VALUE。
總結(jié)
以上是生活随笔為你收集整理的java中表示根号三_Java命名规范的全部內(nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: mysql建立电影表_【代码片段】MyS
- 下一篇: java 死锁 内存消耗_详解Java中