j2ee項(xiàng)目代碼規(guī)范文檔-wenkub
2023-05-01 05:38:31 本頁(yè)面
【正文】 相應(yīng)的注釋，通常來(lái)講一個(gè)源文件不應(yīng)該超過(guò)行，否則就是視為類“臃腫”，這種情況在程序設(shè)計(jì)時(shí)，應(yīng)該盡量避免。定義這個(gè)規(guī)范的目的是讓項(xiàng)目中所有的代碼、文檔都具有統(tǒng)一的風(fēng)格，增加程序的可讀性，減少項(xiàng)目組中因?yàn)槿蝿?wù)移交等原因造成的時(shí)間浪費(fèi)，提高代碼的可維護(hù)性。項(xiàng)目代碼規(guī)范文檔版本 14 / 14修訂歷史記錄日期版本說(shuō)明作者20XX125創(chuàng)建王悅邦20XX126修改王悅邦20XX0715修改蘇謨目錄文件名與文件組織結(jié)構(gòu)矚慫潤(rùn)厲釤瘞睞櫪廡賴賃軔朧。殘騖樓諍錈瀨濟(jì)溆塹籟婭騍東。釅錒極額閉鎮(zhèn)檜豬訣錐顧葒鈀。 * 該類功能及其特點(diǎn)的描述（例如：該類是用來(lái)實(shí)現(xiàn)頁(yè)面調(diào)轉(zhuǎn)） * * 該類經(jīng)編譯測(cè)試過(guò) * * （與該類相關(guān)聯(lián)的類）：（例如：） *** 開發(fā)公司或單位：中科院沈陽(yáng)計(jì)算所有限公司西南信息中心** 版權(quán)：本文件版權(quán)歸屬中科院沈陽(yáng)計(jì)算所有限公司** * （作者）：王悅邦 * * （該文件所支持的版本）：** （版本）： * * （開發(fā)日期）：20XX96** 最后更改日期：20XX126** 修改人：王悅邦** 復(fù)審人：**************************************************************廈礴懇蹣駢時(shí)盡繼價(jià)騷巹癩龔。包的另一個(gè)作用就是可以將同名的類（）或接口（）分離開來(lái)，不至于產(chǎn)生二義性或以假亂真的錯(cuò)誤。包名應(yīng)該是獨(dú)一無(wú)二不可重復(fù)的；包名通常情況下都應(yīng)該是小寫字母；包名一般是公司域名的倒序，經(jīng)常用到的域名后綴有, , , , , , 等；預(yù)頌圣鉉儐歲齦訝驊糴買闥齙。例如：滲釤嗆儼勻諤鱉調(diào)硯錦鋇絨鈔。類與接口的聲明類與接口可以說(shuō)是程序設(shè)計(jì)中的核心成員，任何采用開發(fā)的應(yīng)用都離不開他們，關(guān)于類與接口的聲明規(guī)則如表所示。在遵從表中的聲明規(guī)則的基礎(chǔ)上，還要注意方法與方法之間都插入一個(gè)空白行，這樣代碼看起來(lái)會(huì)更清楚一些，顯得更有條理，輪廓更為清晰，增強(qiáng)了程序的可讀性。在頂頭代碼行的下屬第二行，通常是一個(gè)鍵，即個(gè)空格鍵。在一些文檔編輯器中慣用長(zhǎng)度普遍為個(gè)字符左右。蠟變黲癟報(bào)倀鉉錨鈰贅籜葦繯。 (, (, ,))。綾鏑鯛駕櫬鶘蹤韋轔糴飆鈧麥。當(dāng)你在利用空格鍵縮進(jìn)時(shí)可能會(huì)看上去比較費(fèi)勁，此時(shí)你可以采用鍵（空格鍵）處理規(guī)則。構(gòu)氽頑黌碩飩薺齦話騖門戲鷯。程序?qū)崿F(xiàn)代碼注釋程序?qū)崿F(xiàn)代碼注釋一般分為兩種風(fēng)格：塊注釋與行注釋。方法塊注釋以** 開頭以*結(jié)尾主要用到的注釋有 參數(shù)注釋,（可重復(fù)使用）使用格式 空格參數(shù)名空格注釋信息 參見(可重復(fù)使用) 返回注冊(cè)（是對(duì)返回對(duì)象的一個(gè)說(shuō)明） 自從（從哪個(gè)版本開始使用的，一個(gè)注釋） 拋出異常 空格類名拋出異常 空格類名*方法內(nèi)的局部變量在生成幫助文檔的時(shí)候不自動(dòng)生成** * 這個(gè)方法是測(cè)試方法 * 版本版本以后開始使用 * 類名是 * 我是拋出的異常 * 我是參數(shù)的注釋 * 我是參數(shù)的注釋 * 我是對(duì)象的注釋 * ( ) { ** * 我是局部變量的注釋 * 。在一個(gè)塊注釋之前一般有一空白行用于做區(qū)分代碼與注釋的邊界。(){ ()。單獨(dú)行注釋在實(shí)現(xiàn)代碼中單起一行書寫注釋信息?！?( ){ 。 *否則返回假*} ( ){ *做相應(yīng)處理* … } { 。 } ** * 設(shè)置備注 * ( ) { 。 ( ) { 。 (()) { 39。 } 。不再有用的注釋要?jiǎng)h除；注釋應(yīng)當(dāng)準(zhǔn)確、易懂，防止注釋有二義性；盡量避免在注釋中使用縮寫，特別是不常用的縮寫；注釋的位置應(yīng)與被描述的代碼相鄰，可以放在代碼的上方或右方，不可放在下方；當(dāng)代碼比較長(zhǎng)，特別是有多重潛逃時(shí)，應(yīng)當(dāng)在一些段落的結(jié)束處加注釋，便于程序的閱讀。 。()。 部門級(jí)別***部門人數(shù)* 。熒紿譏鉦鏌觶鷹緇機(jī)庫(kù)圓鍰緘。 *代碼段起始
公司管理相關(guān)推薦
鄂ICP備17016276號(hào)-1