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