【文章內(nèi)容簡介】 //并且條件二 || Condition3){ //或者條件三 } /*相應(yīng)獨(dú)立的功能模塊之間可使用注釋行間隔，并標(biāo)明相應(yīng)內(nèi)容 */ for(int i = 0。 i 。 //循環(huán)終止條件 i++){ } 代碼組織與風(fēng)格 7 括號 {} 中的語句應(yīng)該單獨(dú)作為一行，左括號 {當(dāng)緊跟其語句后，右括號 }永遠(yuǎn)單獨(dú)作為一行且與其匹配行對齊，并盡量在其后說明其匹配的功能模塊。 較長的方法以及類、接口等的右括號后應(yīng)使用//end ...等標(biāo)識其結(jié)束。如 : 類的結(jié)束符： }//EOC ClassName， 方法結(jié)束符： }//end methodName()， 功能塊結(jié)束： }//end if...userName is null? 循環(huán)快結(jié)束： }//end for...every user in userList 左括號是否換行等隨個人習(xí)慣而定，若換行則當(dāng)與其前導(dǎo)語句首字符對齊。 ?注釋分為序言性注釋和功能性注釋 ?功能性注釋嵌在源程序體中，用以描述其后的語句或程序段是在做什么工作，或是執(zhí)行了下面的語句會怎么樣。而不要解釋下面怎么做。 ?例如， /* ADD AMOUNT TO TOTAL */ TOTAL = AMOUNT＋ TOTAL 不好。 ?如果注明把月銷售額計(jì)入年度總額，便使讀者理解了下面語句的意圖： /* ADD MONTHLYSALES TO ANNUALTOTAL */ TOTAL = AMOUNT＋ TOTAL 1基本原則 (1) 注釋應(yīng)該增加代碼的清晰度。代碼注釋的目的是要使代碼更易于被其他開發(fā)人員等理解。 (2) 如果你的程序不值得注釋，那么它很可能也不值得運(yùn)行。 (3) 避免使用裝飾性內(nèi)容。 (4) 保持注釋的簡潔。 (5) 注釋信息不僅要包括代碼的功能，還應(yīng)給出原因。 (6) 不要為注釋而注釋。 (7) 除變量定義等較短語句的注釋可用行尾注釋外，其他注釋當(dāng)避免使用行尾注釋。 2文件注釋 在每個文件的頭部都應(yīng)該包含該文件的功能、作用、作者、版權(quán)以及創(chuàng)建、修改記錄等。 /* ============================================================ * FileName: * Created: [202296 20:18:53] by 彭輝 * ============================================================ * Copyright: Copyright (c) 成都信息工程學(xué)院 , 20222022 * ============================================================ * Description: 在這兒對整個文件進(jìn)行描述 * * ========================================================== * Modification Hisytory: * 1. 202296, 彭輝創(chuàng)建了此文件 * 2. 對這個文件的修改歷史進(jìn)行詳細(xì)描述，一般包括時間，修改者， * 修改的內(nèi)容描述，修改的原因 */ 3類、接口注釋 在類、接口定義之前當(dāng)對其進(jìn)行注釋，包括類、接口的目的、作用、功能、繼承于何種父類，實(shí)現(xiàn)的接口、實(shí)現(xiàn)的算法、使用方法、示例程序等。 /****************************************************** 類名 ： StringUtil 功能 ：定義字符串操作時所需要用到的方法，如 轉(zhuǎn)換中文、 HTML標(biāo)記處理等。 作者 ： 彭輝 版本 ： 備注 ： *****************************************************/ public class StringUtil { ? } 4 方法注釋 ?明確該方法功能、作用、各參數(shù)含義以及返回值等。復(fù)雜的算法用 /**/在方法內(nèi)注解出。 ?參數(shù)注釋時當(dāng)注明其取值范圍等。 ?返回值當(dāng)注釋出失敗、錯誤、異常時的返回情況。 ?異常當(dāng)注釋出什么情況、什么時候、什么條件下會引發(fā)什么樣的異常 /******************************************************************* ********** 函數(shù)名 ： executeQuery 功能 ：該方法根據(jù) SQL語句，查詢數(shù)據(jù)庫，返回它的結(jié)果集 參數(shù) ： sql[in]:標(biāo)準(zhǔn)的 SQL語句 ，不可以為空串 返回值 ： ResultSet結(jié)果集，若查詢失敗則返回 null 異常 ： SQLException ，當(dāng)查詢數(shù)據(jù)庫時可能引發(fā)此異常 備注 ： *****************************************************************************/ public ResultSet executeQuery(String sql) throws SQLException { //Statement和 SQL語句都不能為空 if(null != stmt amp。amp。 !(sql)){ //返回查詢執(zhí)行結(jié)果 return (sql)。 } return null。 }//end executeQuery() 5 其他注釋 ?應(yīng)對重要的變量加以注釋，以說明其含義等。 ?應(yīng)對不易理解的分支條件表達(dá)式加注釋。不易理解的循環(huán)，應(yīng)說明出口條件。過長的方法實(shí)現(xiàn)，應(yīng)將其語句按實(shí)現(xiàn)的功能分段加以概括性說明。 ?對于異常處理，當(dāng)注明正常情況及異常情況的條件，并說明當(dāng)異常發(fā)生時程序當(dāng)如何處理。 注釋在源代碼中的比例一般為 20%左右 1基本原則 規(guī)范的命名能使程序更易閱讀，從而更易于理解。它們也可以提供一些標(biāo)識功能方面的信息，有助于更好的理解代碼和應(yīng)用。 ?名字應(yīng)能反映它所代表的實(shí)際東西，應(yīng)有一定實(shí)際意義。例如，表示次數(shù)的量用 Times，表示總量的用 Total，表示平均值的用 Average，表示和的量用 Sum等 ?使用可以準(zhǔn)確說明變量 /字段 /類 /接口 /包等的完整的英文描述符。例如，采用類似 firstName， listAllUsers 或 CorporateCustomer 這樣的名字，嚴(yán)禁使用漢語拼音及不相關(guān)單詞命名。 ?采用該領(lǐng)域的術(shù)語。如果用戶稱他們的“客戶” (clients) 為“顧客” (customers)，那么就采用術(shù)語 Customer 來命名這個類，而不用 Client。 ?采用大小寫混合，提高名字的可讀性。一般應(yīng)該采用小寫字母，但是類和接口的名字的首字母，以及任何中間單詞的首字母應(yīng)該大寫。 ?盡量少用縮寫，但如果一定要使用，當(dāng)使用公共縮寫和習(xí)慣縮寫等，如實(shí)現(xiàn)（ implement）可縮寫成 impl，經(jīng)理（ manager）可縮寫成 mgr等，嚴(yán)禁濫用縮寫。 ?避免使