j2ee項(xiàng)目代碼規(guī)范文檔(編輯修改稿)
2025-05-13 05:38 本頁面
【文章內(nèi)容簡(jiǎn)介】 齦話騖門戲鷯。注釋在程序中分為兩類：程序頭注釋與程序?qū)崿F(xiàn)代碼注釋。程序頭注釋參考部分的內(nèi)容，下面主要提供程序?qū)崿F(xiàn)代碼注釋的原則。輒嶧陽檉籪癤網(wǎng)儂號(hào)澩蠐鑭釃。程序?qū)崿F(xiàn)代碼注釋程序?qū)崿F(xiàn)代碼注釋一般分為兩種風(fēng)格：塊注釋與行注釋。塊注釋代碼塊注釋經(jīng)常被用于提供文件、方法、數(shù)據(jù)結(jié)構(gòu)、變量的意義與用途，以及算法的描述。塊注釋一般位于一個(gè)文件或一個(gè)方法的前面，當(dāng)然如需要它可以位于任意的地方，如方法體內(nèi)。堯側(cè)閆繭絳闕絢勵(lì)蜆贅瀝紕縭。方法塊注釋以** 開頭以*結(jié)尾主要用到的注釋有 參數(shù)注釋,（可重復(fù)使用）使用格式 空格參數(shù)名空格注釋信息 參見(可重復(fù)使用) 返回注冊(cè)（是對(duì)返回對(duì)象的一個(gè)說明） 自從（從哪個(gè)版本開始使用的，一個(gè)注釋） 拋出異常 空格類名拋出異常 空格類名*方法內(nèi)的局部變量在生成幫助文檔的時(shí)候不自動(dòng)生成** * 這個(gè)方法是測(cè)試方法 * 版本版本以后開始使用 * 類名是 * 我是拋出的異常 * 我是參數(shù)的注釋 * 我是參數(shù)的注釋 * 我是對(duì)象的注釋 * ( ) { ** * 我是局部變量的注釋 * 。 。 } 注：標(biāo)簽后邊空格類名，空格注釋：但是注釋會(huì)把類名覆蓋掉，所以最好不加注釋，只寫類名。方法內(nèi)塊注釋位于方法體內(nèi)的塊注釋應(yīng)該與其所描述的代碼位于同一個(gè)層次上。在一個(gè)塊注釋之前一般有一空白行用于做區(qū)分代碼與注釋的邊界。塊注釋以“*”開始，以“*”終結(jié)，例如：識(shí)饒鎂錕縊灩筧嚌儼淒儂減攙。 ** 進(jìn)行權(quán)限判斷* (,)。凍鈹鋨勞臘鍇癇婦脛糴鈹賄鶚。(){ ()。 }行注釋行注釋又分為三種：?jiǎn)为?dú)行注釋、行尾注釋與行頭注釋。之所以把他們統(tǒng)稱為行注釋，因?yàn)樗鼈兊淖⑨岋L(fēng)格都不換行，都在同一行內(nèi)。恥諤銪滅縈歡煬鞏鶩錦聰櫻鄶。單獨(dú)行注釋在實(shí)現(xiàn)代碼中單起一行書寫注釋信息。單獨(dú)行注釋一般用于對(duì)較短的注釋信息的描述。例如：…… (){* 處理代碼模塊*…}……行尾注釋行尾注釋與單獨(dú)行注釋類似，所不同的是單獨(dú)行注釋要單起一行，而行尾注釋則緊跟在這一行代碼之后進(jìn)行注釋，原則上代碼與注釋存在于不可分割的統(tǒng)一行，但為了使代碼更加清晰，我們一般采用“代碼行＋鍵（個(gè)空格字符）＋行尾注釋”的格式編排程序。例如：鯊腎鑰詘褳鉀溈懼統(tǒng)庫搖飭緡?！?( ){ 。 * 如果等于則返回真*} { * 如果不等于則返回假*}……行頭注釋行頭注釋是用來注釋代碼的，使代碼失去意義，行頭注釋在程序調(diào)試中經(jīng)常被用到，如果注釋的代碼行過多并且更改頻繁，請(qǐng)采用塊注釋以提高效率。例如：碩癘鄴頏謅攆檸攜驤蘞鷥膠據(jù)?！?( ){*做相應(yīng)處理*…} { 。 *否則返回假*} ( ){ *做相應(yīng)處理* … } { 。 *否則返回假* }……類注釋與注釋在方法的上方注釋對(duì)此方法的描述、返回值?？梢苑奖憧焖俚牧私獯朔椒ǖ挠猛尽＠纾?* * 獲得備注 * 備注 * () { 。 } ** * 設(shè)置備注 * ( ) { 。 }在方法的上方注釋對(duì)此方法的描述、參數(shù)、返回值。使用戶可以方便快速的了解此方法的用途。例如：** * 實(shí)現(xiàn)舉報(bào)信息查詢?nèi)啃畔⒐δ? * 舉報(bào)投訴 * 權(quán)限 * 查詢后的信息 * ( ){閿擻輳嬪諫遷擇楨秘騖輛塤鵜。 ( ) { 。 } { 39。39。氬嚕躑竄貿(mào)懇彈瀘頷澩紛釓鄧。 (()) { 39。39。 釷鵒資贏車贖孫滅獅贅慶獷緞。 。 } 。 ()。 。 }注釋規(guī)則注釋是對(duì)代碼的“提示”，而不是文檔；如果代碼本來就是清楚的，則不必加注釋；邊寫代碼邊加注釋，修改代碼同時(shí)修改相應(yīng)的注釋，以保證注釋與代碼的一致性。不再有用的注釋要?jiǎng)h除；注釋應(yīng)當(dāng)
公司管理相關(guān)推薦
鄂ICP備17016276號(hào)-1