資源描述：
《Java Coding Rule》由會(huì)員上傳分享，免費(fèi)在線閱讀，更多相關(guān)內(nèi)容在教育資源-天天文庫(kù)。
1、TarenaIT集團(tuán)TarenaJavaCodingRule文檔編號(hào)Version1.0.02008-8-24達(dá)內(nèi)IT集團(tuán)攜手與你并進(jìn)TarenaIT集團(tuán)履歷版本標(biāo)題內(nèi)容作者時(shí)間1.0.0創(chuàng)建創(chuàng)建高輝08/28/20081.0.1修訂修訂格式馬東鋒08/28/2008攜手與你并進(jìn)TarenaIT集團(tuán)1方針本說(shuō)明書是向開發(fā)人員提供用Java來(lái)編程的規(guī)則和指針。規(guī)約的方針是編寫易讀及易維護(hù)的代碼。在實(shí)際編程時(shí)，項(xiàng)目組全體開發(fā)人員需嚴(yán)格遵守此規(guī)則。2命名規(guī)則2.1Package名特定package名的前綴應(yīng)是通常只用小寫字母書
2、寫的最高標(biāo)準(zhǔn)的域名(現(xiàn)在是由com、edu、gov、mil、net、org、或ISO_3166所規(guī)定的2個(gè)文字的字母表來(lái)表示的國(guó)家編碼)。前綴的接續(xù)部分是根據(jù)編程組織的原本的命名規(guī)則來(lái)規(guī)定。此規(guī)則規(guī)定目錄名為部署、部門、project、machine或注冊(cè)名。另外，由兩個(gè)以上詞構(gòu)成的目錄名也全部用小寫字母來(lái)命名。例: com.mc.pf.common.properties2.2文件名用該文件中的publicclass名作為文件名。例: publicclassPoint{…}所以文件名為Point.java2.3類名類名
3、首字母及各單詞的首字母為大寫字母。注意 "Test"這個(gè)單詞在類名中不使用。例: WordsCapitalizedl例外的類名例外的類名首字母為大寫字母、各單詞的首字母為大寫字母、Exception用作為末尾的類名。注意 "Test"這個(gè)單詞在例外的類名中不使用。(保留作為JUnit的TestClass命名用)例: ClassNameEndsWithExceptionl接口名接口名首字母為大寫字母、各單詞的首字母為大寫字母。注意 "Test"這個(gè)單詞在接口名中不使用。例: NameOfInterface另外，要表示
4、添加類里特定功能的接口時(shí)，用末尾是able的接口名。例: Runnable、Clonable、Serializable、…l實(shí)現(xiàn)類名攜手與你并進(jìn)TarenaIT集團(tuán)實(shí)現(xiàn)類名是在所實(shí)現(xiàn)的接口名末尾添加Impl。但是，在擴(kuò)展功能實(shí)現(xiàn)類的情況下，根據(jù)不同用途來(lái)命名。注意 "Test"這個(gè)單詞在實(shí)現(xiàn)類名中部使用。例: 接口ClassNameEndsWith的實(shí)現(xiàn)類。ClassNameEndsWithImpl接口RequestHandler的擴(kuò)展實(shí)現(xiàn)類。SalesRequestHandlerl抽象類名抽象類名從Abstract開
5、始，各單詞的首字母為大寫字母。注意 "Test"這個(gè)單詞在抽象類名中不使用。例: AbstractBeforeSubClassNamel常量類名、常量接口名常量類、常量接口在本系統(tǒng)無(wú)特別規(guī)定。l單體測(cè)試類名單體測(cè)試類名是在測(cè)試的類名的末尾添加test。例: DateUtil類的測(cè)試類名是DateUtilTest.java測(cè)試類的位置測(cè)試類放在與測(cè)試對(duì)象類相同的目錄里。補(bǔ)充：有關(guān)測(cè)試類和測(cè)試對(duì)象類分離，可用其他工具(Ant的build.xml)調(diào)整。2.4常量名常量名全部使用大寫字母，單詞用"_"連接。例: UPPER_
6、CASE_WITH_UNDERSCORES另外，做為半常量（只作參照用）的Map、List等的object名也和常量名一樣。2.5變量名變量名取一個(gè)有意思的名字。由2個(gè)單詞以上構(gòu)成的變量名首字母為小寫文字，各單詞的首字母為大寫文字。例:employeeStateNumberl類變量名、接口變量名類變量名、接口變量名以"_"開始。例: _fieldl局部變量名局部變量名無(wú)特別的規(guī)定，取一有意思的名字即可。2.6方法名攜手與你并進(jìn)TarenaIT集團(tuán)lfactory方法所謂factory方法是指生成object。寫成crea
7、te()。例:publicEmployeecreateEmployee()lConverter方法所謂Converter方法是指把object轉(zhuǎn)換成其他的object。寫成to()。例:publicEmployeetoEmployee()l屬性的取得方法寫成get<屬性名>()。例:publicEmployeegetEmployee()l屬性的設(shè)定方法寫成set<屬性名>(…)。例:publicvoidsetEmployee(Employeeemployee)l返回boolea
8、n變量的方法返回boolean變量的方法名在if、while等的條件句中使用時(shí)取一個(gè)易分辨true是那個(gè)意思的名字。booleanisEmpty()booleancanGet()booleanhasChanged()booleancontains(Object)booleancontainsKey(Key)l循環(huán)變量
