【文章內(nèi)容簡(jiǎn)介】 . *避免在一行代碼或表達(dá)式的中間插入注釋。說(shuō)明：除非必要，不應(yīng)在代碼或表達(dá)中間插入注釋，否則容易使代碼可理解性變差。 . *通過(guò)對(duì)函數(shù)或過(guò)程、變量、結(jié)構(gòu)等正確的命名以及合理地組織代碼的結(jié)構(gòu)，使代碼成為自注釋的。說(shuō)明：清晰準(zhǔn)確的函數(shù)、變量等的命名，可增加代碼可讀性，并減少不必要的注釋。 . *在代碼的功能、意圖層次上進(jìn)行注釋，提供有用、額外的信息。說(shuō)明：注釋的目的是解釋代碼的目的、功能和采用的方法，提供代碼以外的信息，幫助讀者理解代碼，防止沒(méi)必要的重復(fù)注釋信息。示例：如下注釋意義不大。// 如果 receiveFlag 為真if (receiveFlag) 而如下的注釋則給出了額外有用的信息。 // 如果從連結(jié)收到消息 if (receiveFlag) . *在程序塊的結(jié)束行右方加注釋標(biāo)記，以表明某程序塊的結(jié)束。說(shuō)明：當(dāng)代碼段較長(zhǎng)，特別是多重嵌套時(shí)，這樣做可以使代碼更清晰，更便于閱讀。示例：參見(jiàn)如下例子。if (...){ program code1 while (index MAX_INDEX) { program code2 } // end of while (index MAX_INDEX) // 指明該條while語(yǔ)句結(jié)束} // end of if (...) // 指明是哪條if語(yǔ)句結(jié)束 . *注釋應(yīng)考慮程序易讀及外觀排版的因素，使用的語(yǔ)言若是中、英兼有的，建議多使用中文，除非能用非常流利準(zhǔn)確的英文表達(dá)。說(shuō)明：注釋語(yǔ)言不統(tǒng)一，影響程序易讀性和外觀排版，出于維護(hù)的考慮，建議使用中文。 . 方法內(nèi)的單行注釋使用 //。說(shuō)明：調(diào)試程序的時(shí)候可以方便的使用 /* 。*/ 注釋掉一長(zhǎng)段程序。. 注釋盡量使用中文注釋和中文標(biāo)點(diǎn)。方法和類描述的第一句話盡量使用簡(jiǎn)潔明了的話概括一下功能，然后加以句號(hào)。接下來(lái)的部分可以詳細(xì)描述。說(shuō)明：JavaDoc工具收集簡(jiǎn)介的時(shí)候使用選取第一句話。 . 順序?qū)崿F(xiàn)流程的說(shuō)明使用4在每個(gè)實(shí)現(xiàn)步驟部分的代碼前面進(jìn)行注釋。示例：如下是對(duì)設(shè)置屬性的流程注釋 // 判斷輸入?yún)?shù)是否有效。 。 // 設(shè)置本地變量。 。 . 一些復(fù)雜的代碼需要說(shuō)明。示例：這里主要是對(duì)閏年算法的說(shuō)明。 //1. 如果能被4整除，是閏年； //2. 如果能被100整除，不是閏年.； //3. 如果能被400整除，是閏年.。6. 命名規(guī)范. 規(guī)則. 包名采用域后綴倒置的加上自定義的包名，采用小寫字母。在部門內(nèi)部應(yīng)該規(guī)劃好包名的范圍，防止產(chǎn)生沖突。部門內(nèi)部產(chǎn)品使用部門的名稱加上模塊名稱。產(chǎn)品線的產(chǎn)品使用產(chǎn)品的名稱加上模塊的名稱。格式：. 項(xiàng)目名稱示例：Relay模塊包名 通用日志模塊包名 . 類名和接口使用類意義完整的英文描述，每個(gè)英文單詞的首字母使用大寫、其余字母使用小寫的大小寫混合法。示例：OrderInformation, CustomerList, LogManager, LogConfig . 方法名使用類意義完整的英文描述：第一個(gè)單詞的字母使用小寫、剩余單詞首字母大寫其余字母小寫的大小寫混合法。示例：private void calculateRate()。public void addNewOrder()。 . 方法中，存取屬性的方法采用setter 和 getter方法，動(dòng)作方法采用動(dòng)詞和動(dòng)賓結(jié)構(gòu)。格式：get + 非布爾屬性名()is + 布爾屬性名()set + 屬性名()動(dòng)詞()動(dòng)詞 + 賓語(yǔ)()示例：public String getType()。public boolean isFinished()。public void setVisible(boolean)。public void show()。public void addKeyListener(Listener)。 . 屬性名使用意義完整的英文描述：第一個(gè)單詞的字母使用小寫、剩余單詞首字母大寫其余字母小寫的大小寫混合法。屬性名不能與方法名相同。示例： private customerName。private orderNumber。private smpSession。 . 常量名使用全大寫的英文描述，英文單詞之間用下劃線分隔開(kāi)，并且使用 final static 修飾。示例： public final static int MAX_VALUE = 1000。public final static String DEFAULT_START_DATE = 20011208。 . 屬性名可以和公有方法參數(shù)相同，不能和局部變量相同，引用非靜態(tài)成員變量時(shí)使用 this 引用，引用靜態(tài)成員變量時(shí)使用類名引用。示例：public class Person{ private String name。 private static List properties。 public void setName (String name) { = name。 } public void setProperties (List properties) { = properties。 }}. 建議. 常用組件類的命名以組件名加上組件類型名結(jié)尾。示例：Application 類型的，命名以App 結(jié)尾——MainAppFrame 類型的，命名以Frame 結(jié)尾——TopoFramePanel 類型的，建議命名以Panel 結(jié)尾——CreateCircuitPanelBean 類型的，建議命名以Bean 結(jié)尾——DataAccessBeanEJB 類型的，建議命名以EJB 結(jié)尾——DBProxyEJBApplet 類型的，建議命名以Applet 結(jié)尾——PictureShowApplet . 如果函數(shù)名超過(guò)15 個(gè)字母，可采用以去掉元音字母的方法或者以行業(yè)內(nèi)約定俗成的縮寫方式縮寫函數(shù)名。示例：getCustomerInformation() 改為 getCustomerInfo() . 準(zhǔn)確地確定成員函數(shù)的存取控制符號(hào)，不是必須使用 public 屬性的，請(qǐng)使用 protected，不是必須使用 protected, 請(qǐng)使用 private。示例：protected void setUserName(), private void calculateRate() . 含有集合意義的屬性命名，盡量包含其復(fù)數(shù)的意義。示例：customers, orderItems7. 編碼規(guī)范. 規(guī)則. *明確方法功能，精確（而不是近似）地實(shí)現(xiàn)方法設(shè)計(jì)。一個(gè)函數(shù)僅完成一件功能，即使簡(jiǎn)單功能也應(yīng)該編寫方法實(shí)現(xiàn)。 說(shuō)明：雖然為僅用一兩行就可完成的功能去編方法好象沒(méi)有必要，但用方法可使功能明確化，增加程序可讀性，亦可方便維護(hù)、測(cè)試。 . 應(yīng)明確規(guī)定對(duì)接口方法參數(shù)的合法性檢查應(yīng)由方法的調(diào)用者負(fù)責(zé)還是由接口方法本身負(fù)責(zé)，缺省是由方法調(diào)用者負(fù)責(zé)。說(shuō)明：對(duì)于模塊間接口方法的參數(shù)的合法性檢查這一問(wèn)題，往往有兩個(gè)極端現(xiàn)象，即：要么是調(diào)用者和被調(diào)用者對(duì)參數(shù)均不作合法性檢查，結(jié)果就遺漏了合法性檢查這一必要的處理過(guò)程，造成問(wèn)題隱患；要么就是調(diào)用者和被調(diào)用者均對(duì)參數(shù)進(jìn)行合法性檢查，這種情況雖不會(huì)造成問(wèn)題，但產(chǎn)生了冗余代碼，降低了效率。 . 明確類的功能，精確（而非近似）地實(shí)現(xiàn)類的設(shè)計(jì)。一個(gè)類僅實(shí)現(xiàn)一組相近的功能。說(shuō)明：劃分類的時(shí)候，應(yīng)該盡量把邏輯處理、數(shù)據(jù)和顯示分離，實(shí)現(xiàn)類功能的單一性。示例：數(shù)據(jù)類不能包含數(shù)據(jù)處理的邏輯。通信類不能包含顯示處理的邏輯。 . 所有的數(shù)據(jù)類必須重載toString() 方法，返回該類有意義的內(nèi)容。說(shuō)明： 父類如果實(shí)現(xiàn)了比較合理的toString() ，子類可以繼承不必再重寫。示例：public TopoNode{ private String nodeName。 public String toString() { return NodeName : + nodeName。 }