j2ee項(xiàng)目代碼規(guī)范文檔-文庫(kù)吧資料
2025-04-22 05:38本頁(yè)面
【正文】 (()) { 39。39。 ( ) { 。使用戶(hù)可以方便快速的了解此方法的用途。 } ** * 設(shè)置備注 * ( ) { 。可以方便快速的了解此方法的用途。 *否則返回假*} ( ){ *做相應(yīng)處理* … } { 。例如：碩癘鄴頏謅攆檸攜驤蘞鷥膠據(jù)。…… ( ){ 。例如：…… (){* 處理代碼模塊*…}……行尾注釋行尾注釋與單獨(dú)行注釋類(lèi)似，所不同的是單獨(dú)行注釋要單起一行，而行尾注釋則緊跟在這一行代碼之后進(jìn)行注釋?zhuān)瓌t上代碼與注釋存在于不可分割的統(tǒng)一行，但為了使代碼更加清晰，我們一般采用“代碼行＋鍵（個(gè)空格字符）＋行尾注釋”的格式編排程序。單獨(dú)行注釋在實(shí)現(xiàn)代碼中單起一行書(shū)寫(xiě)注釋信息。之所以把他們統(tǒng)稱(chēng)為行注釋?zhuān)驗(yàn)樗鼈兊淖⑨岋L(fēng)格都不換行，都在同一行內(nèi)。(){ ()。 ** 進(jìn)行權(quán)限判斷* (,)。在一個(gè)塊注釋之前一般有一空白行用于做區(qū)分代碼與注釋的邊界。 } 注：標(biāo)簽后邊空格類(lèi)名，空格注釋?zhuān)旱亲⑨寱?huì)把類(lèi)名覆蓋掉，所以最好不加注釋?zhuān)粚?xiě)類(lèi)名。方法塊注釋以** 開(kāi)頭以*結(jié)尾主要用到的注釋有 參數(shù)注釋,（可重復(fù)使用）使用格式 空格參數(shù)名空格注釋信息 參見(jiàn)(可重復(fù)使用) 返回注冊(cè)（是對(duì)返回對(duì)象的一個(gè)說(shuō)明） 自從（從哪個(gè)版本開(kāi)始使用的，一個(gè)注釋?zhuān)?拋出異常 空格類(lèi)名拋出異常 空格類(lèi)名*方法內(nèi)的局部變量在生成幫助文檔的時(shí)候不自動(dòng)生成** * 這個(gè)方法是測(cè)試方法 * 版本版本以后開(kāi)始使用 * 類(lèi)名是 * 我是拋出的異常 * 我是參數(shù)的注釋 * 我是參數(shù)的注釋 * 我是對(duì)象的注釋 * ( ) { ** * 我是局部變量的注釋 * 。塊注釋一般位于一個(gè)文件或一個(gè)方法的前面，當(dāng)然如需要它可以位于任意的地方，如方法體內(nèi)。程序?qū)崿F(xiàn)代碼注釋程序?qū)崿F(xiàn)代碼注釋一般分為兩種風(fēng)格：塊注釋與行注釋。程序頭注釋參考部分的內(nèi)容，下面主要提供程序?qū)崿F(xiàn)代碼注釋的原則。構(gòu)氽頑黌碩飩薺齦話(huà)騖門(mén)戲鷯。程序注釋注釋在程序中是相當(dāng)重要的一部分，注釋的目的在于說(shuō)明程序，給自己或他人在閱讀程序時(shí)提供幫助，使程序更容易理解，也就是增強(qiáng)程序代碼的可讀性。當(dāng)你在利用空格鍵縮進(jìn)時(shí)可能會(huì)看上去比較費(fèi)勁，此時(shí)你可以采用鍵（空格鍵）處理規(guī)則。 ) { ...}* 鍵（空格鍵）深度折行* ( ,貓蠆驢繪燈鮒誅髏貺廡獻(xiàn)鵬縮。綾鏑鯛駕櫬鶘蹤韋轔糴飆鈧麥。 * ( – ) * *良好的風(fēng)格*此例中我們采用了折行規(guī)則中的折行原則：高層折行優(yōu)于底層折行。 (, (, ,))。(, , ,買(mǎi)鯛鴯譖曇膚遙閆擷凄屆嬌擻。蠟變黲癟報(bào)倀鉉錨鈰贅籜葦繯。折行規(guī)則當(dāng)完整的一行代碼難以編排在同一個(gè)代碼行中時(shí)，我們可以根據(jù)下面的規(guī)則，對(duì)源代碼進(jìn)行折行編排：在逗號(hào)后折行；在運(yùn)算符（）前折行；高層折行優(yōu)于底層折行；折下的代碼行應(yīng)該與其同等級(jí)的代碼行左對(duì)齊。在一些文檔編輯器中慣用長(zhǎng)度普遍為個(gè)字符左右。代碼行長(zhǎng)度與折行規(guī)則代碼行長(zhǎng)度一般來(lái)說(shuō)的代碼行長(zhǎng)度應(yīng)該小于個(gè)字符，超過(guò)這個(gè)長(zhǎng)度可能在一些開(kāi)發(fā)工具或編譯器上就無(wú)法很好地顯示，而且也會(huì)給閱讀程序帶來(lái)麻煩。在頂頭代碼行的下屬第二行，通常是一個(gè)鍵，即個(gè)空格鍵。源文件編排格式源文件的一般編排格式中的行間縮緊，是以四個(gè)空格鍵（）為單位的，當(dāng)然這并沒(méi)有權(quán)威的文獻(xiàn)可做參考，只是對(duì)一般情況而言是這樣的，這樣看起來(lái)代碼格式更清晰、更具美感。在遵從表中的聲明規(guī)則的基礎(chǔ)上，還要注意方法與方法之間都插入一個(gè)空白行，這樣代碼看起來(lái)會(huì)更清楚一些，顯得更有條理，輪廓更為清晰，增強(qiáng)了程序的可讀性。表 類(lèi)與接口的聲明序號(hào)類(lèi)與接口的聲明聲明規(guī)則類(lèi)與接口文件頭的注釋?xiě)?yīng)采用（**…*）的注釋格式具體的書(shū)寫(xiě)格式及其內(nèi)容，參考部分類(lèi)與接口的聲明類(lèi)與接口的名字一般由大寫(xiě)字母開(kāi)頭，其他字母都小寫(xiě)的單詞組成，并且類(lèi)的名字應(yīng)盡量具有清晰的實(shí)際意義類(lèi)與接口實(shí)現(xiàn)部分的注釋?xiě)?yīng)采用（*…*）的注釋格式這種注釋方式一般適用于類(lèi)的
公司管理相關(guān)推薦
鄂ICP備17016276號(hào)-1