資源描述:
《java,代碼書(shū)寫(xiě)規(guī)范》由會(huì)員上傳分享,免費(fèi)在線閱讀,更多相關(guān)內(nèi)容在應(yīng)用文檔-天天文庫(kù)。
1、自從人類進(jìn)入商品經(jīng)濟(jì)社會(huì)以來(lái),貿(mào)易即已成為人們?nèi)粘;顒?dòng)的主要部分,并成為一國(guó)經(jīng)濟(jì)增長(zhǎng)的主動(dòng)力。國(guó)際分工的深化、大量國(guó)際統(tǒng)一標(biāo)準(zhǔn)規(guī)則的建立java,代碼書(shū)寫(xiě)規(guī)范 篇一:Java代碼書(shū)寫(xiě)規(guī)范(高手必經(jīng)之路) ?符號(hào)命名規(guī)則 符號(hào)名包括:模塊名,變量名,常量名,方法(函數(shù)/子程序)名,數(shù)據(jù)區(qū)名,緩沖區(qū)名等。符號(hào)命名通常應(yīng)遵循以下規(guī)則: 通用規(guī)則: 1、在所有命名中,都應(yīng)使用標(biāo)準(zhǔn)的英文單詞或縮寫(xiě)。不得使用拼音或拼音縮寫(xiě),除非該名字描述的是中文特有的內(nèi)容,如半角、全角,聲母、韻母等?! ?、所有命名都應(yīng)遵循達(dá)意原則,即名稱應(yīng)含義清
2、晰、明確。 3、所有命名都不易過(guò)長(zhǎng),應(yīng)控制在規(guī)定的最大長(zhǎng)度以內(nèi)?! ?、所有命名都應(yīng)盡量使用全稱。 5、如果命名使用縮寫(xiě),則必須對(duì)其進(jìn)行注釋和說(shuō)明?! 【唧w規(guī)范: 1、工程名統(tǒng)一制訂?! ?、文件名 文件名應(yīng)與類名相同,這是java的規(guī)范 3、方法名/函數(shù)名 ?·方法名第一個(gè)單詞小寫(xiě)。隨著信息化和全球化的發(fā)展,國(guó)家及地區(qū)之間的貿(mào)易也已成為拉動(dòng)一國(guó)經(jīng)濟(jì)的三駕馬車(chē)之一,甚至是三駕馬車(chē)之首,奧巴馬政府成立之日起自從人類進(jìn)入商品經(jīng)濟(jì)社會(huì)以來(lái),貿(mào)易即已成為人們?nèi)粘;顒?dòng)的主要部分,并成為一國(guó)經(jīng)濟(jì)增長(zhǎng)的主動(dòng)力。國(guó)際分工的深化、大量國(guó)
3、際統(tǒng)一標(biāo)準(zhǔn)規(guī)則的建立 ?·推薦使用動(dòng)賓結(jié)構(gòu)。方法名應(yīng)清晰反映該方法的功能、用途。?·方法名最長(zhǎng)不得超過(guò)30個(gè)字符?! ±骸 etCollection(); setCollection(); insertObject(); deleteObject(); 3、變量名 必須使用有意義的變量名?! ⊥扑]的類型縮寫(xiě)(type)—— ·char:ch ·boolean:b ·int:i ·long:l ·double:d ·float:f 變量名最長(zhǎng)不得超過(guò)20個(gè)字符?! ?、類名 ?·必須以大寫(xiě)字母開(kāi)頭,類
4、名反映具體含義,以清晰表達(dá)類的用途和功能為 原則 ?隨著信息化和全球化的發(fā)展,國(guó)家及地區(qū)之間的貿(mào)易也已成為拉動(dòng)一國(guó)經(jīng)濟(jì)的三駕馬車(chē)之一,甚至是三駕馬車(chē)之首,奧巴馬政府成立之日起自從人類進(jìn)入商品經(jīng)濟(jì)社會(huì)以來(lái),貿(mào)易即已成為人們?nèi)粘;顒?dòng)的主要部分,并成為一國(guó)經(jīng)濟(jì)增長(zhǎng)的主動(dòng)力。國(guó)際分工的深化、大量國(guó)際統(tǒng)一標(biāo)準(zhǔn)規(guī)則的建立·當(dāng)名稱由多個(gè)單詞構(gòu)成時(shí),每一個(gè)單詞的第一個(gè)字母必須大寫(xiě) ?代碼書(shū)寫(xiě)規(guī)范 書(shū)寫(xiě)規(guī)范即在編寫(xiě)代碼過(guò)程中所使用的標(biāo)準(zhǔn)格式,主要包括空格的使用、括號(hào)的使用、縮近格式和其他一些內(nèi)容?! ≡创a書(shū)寫(xiě)規(guī)范 1.在.java/.j
5、sp的開(kāi)頭應(yīng)有一段格式統(tǒng)一的說(shuō)明,內(nèi)容包括: a.文件名(Title/FileName); b.創(chuàng)建人(Author); c.文件創(chuàng)建時(shí)間(Date); d.簡(jiǎn)短說(shuō)明文件功能、用途(Description/Function)?! 永骸 ?** *標(biāo)題: *描述: *創(chuàng)建: *作者:用來(lái)實(shí)現(xiàn)計(jì)劃項(xiàng)目審批XX-06-30趙文正 *詳細(xì): */詳細(xì)描述計(jì)劃項(xiàng)目審批的細(xì)節(jié),如何根據(jù)細(xì)節(jié)功能確定方法 2.隨著信息化和全球化的發(fā)展,國(guó)家及地區(qū)之間的貿(mào)易也已成為拉動(dòng)一國(guó)經(jīng)濟(jì)的三駕馬車(chē)之一,甚至是三駕馬車(chē)之首,奧巴馬政府
6、成立之日起自從人類進(jìn)入商品經(jīng)濟(jì)社會(huì)以來(lái),貿(mào)易即已成為人們?nèi)粘;顒?dòng)的主要部分,并成為一國(guó)經(jīng)濟(jì)增長(zhǎng)的主動(dòng)力。國(guó)際分工的深化、大量國(guó)際統(tǒng)一標(biāo)準(zhǔn)規(guī)則的建立除非極其簡(jiǎn)單,否則對(duì)函數(shù)應(yīng)有注釋說(shuō)明。內(nèi)容包括:功能、入口/出口參數(shù),必要時(shí)還可有備注或補(bǔ)充說(shuō)明。 3.每行代碼的長(zhǎng)度推薦為80列,最長(zhǎng)不得超過(guò)120列;折行以對(duì)齊為準(zhǔn)。 4.在類的成員函數(shù)內(nèi)調(diào)用其他類的成員函數(shù)時(shí),其他類的成員函數(shù)可做簡(jiǎn)短說(shuō)明?! ?.函數(shù)入口參數(shù)有缺省值時(shí),應(yīng)注釋說(shuō)明?! ±? floatgetValue(intID,booleanflag){ /*param
7、eterdescription ID:IdentifyNo flag:default=TRUE */ … } 7.elseif必須寫(xiě)在一行?! ?.與‘{’、‘}’有關(guān)的各項(xiàng)規(guī)定: ?、佟畕’、‘}’應(yīng)獨(dú)占一行。在該行內(nèi)可有注釋。 例:正確: for(i=0;i {//..... ("Line="+i+”value=”+Lines[i]); } 不得寫(xiě)做:隨著信息化和全球化的發(fā)展,國(guó)家及地區(qū)之間的貿(mào)易也已成為拉動(dòng)一國(guó)經(jīng)濟(jì)的三駕馬車(chē)之一,甚至是三駕馬車(chē)之首,奧巴馬政府成立之日起自從人類進(jìn)入商品經(jīng)濟(jì)社會(huì)以來(lái),貿(mào)
8、易即已成為人們?nèi)粘;顒?dòng)的主要部分,并成為一國(guó)經(jīng)濟(jì)增長(zhǎng)的主動(dòng)力。國(guó)際分工的深化、大量國(guó)際統(tǒng)一標(biāo)準(zhǔn)規(guī)則的建立 for(i=0;i {("Line="+i+”value=”+Lines[i]); } ?、凇畕’必須另起一行,‘{’之后的代碼必須縮進(jìn)