j2ee項目代碼規(guī)范文檔(已修改)
2025-04-28 05:38 本頁面
【正文】 項目代碼規(guī)范文檔版本 14 / 14修訂歷史記錄日期版本說明作者20XX125創(chuàng)建王悅邦20XX126修改王悅邦20XX0715修改蘇謨目錄文件名與文件組織結構矚慫潤厲釤瘞睞櫪廡賴賃軔朧。文件注釋頭.包的聲明與引用.類與接口的聲明源文件編排格式.代碼行長度與折行規(guī)則.代碼行長度.折行規(guī)則.程序注釋.程序?qū)崿F(xiàn)代碼注釋.注釋規(guī)則.變量的聲明初始化與放置.變量聲明.變量初始化.變量放置程序語句編寫規(guī)則.簡單語句.復合語句.空格與空行的應用規(guī)則.空格的應用規(guī)則.空行的應用規(guī)則.方法、變量與常量的命名規(guī)則.方法的命名規(guī)則.變量的命名規(guī)則.常量的命名規(guī)則序通常說來優(yōu)秀的開發(fā)人員一般都有良好的程序設計風格，優(yōu)秀的管理人員會在自己的開發(fā)團隊中灌輸養(yǎng)成良好程序設計風格的意識，優(yōu)秀的軟件企業(yè)都有自己一套健全、成熟的程序設計風格規(guī)范文檔，用以規(guī)范開發(fā)人員編寫代碼的風格。聞創(chuàng)溝燴鐺險愛氌譴凈禍測樅。定義這個規(guī)范的目的是讓項目中所有的代碼、文檔都具有統(tǒng)一的風格，增加程序的可讀性，減少項目組中因為任務移交等原因造成的時間浪費，提高代碼的可維護性。殘騖樓諍錈瀨濟溆塹籟婭騍東。文件名與文件組織結構文件名由實意文件名后綴組成，后綴名因類型的不同而不同。如表所示。表 后綴名的意義文件類型后綴名源文件字節(jié)碼文件一般說來源文件的結構是這樣的，每一節(jié)代碼之間是由一個空行分割開的，并且每一節(jié)都有相應的注釋，通常來講一個源文件不應該超過行，否則就是視為類“臃腫”，這種情況在程序設計時，應該盡量避免。釅錒極額閉鎮(zhèn)檜豬訣錐顧葒鈀。每一個源文件一般由下面的順序構成：（）文件注釋頭（）包名（）（）引入（）聲明（）類（）或接口（）的聲明部分文件注釋頭類文件注釋頭是用來描述該類功能及其特點，以及相關開發(fā)信息的，如該類的關聯(lián)類（通常情況下不描述系統(tǒng)核心類如, 等）、開發(fā)公司或單位、版權、作者、代碼審定人該類所支持的版本、該類版本、開發(fā)日期、最后更改日期、修改人、復審人等信息。主要用到的注釋有：彈貿(mào)攝爾霽斃攬磚鹵廡詒爾膚。使用格式空格類名（不能帶） 版本號 作者 自從（標識類從什么版本開始使用比如：版本新增類，可以使用這個注釋進行說明） 開發(fā)日期*繼承，實現(xiàn)接口，被繼承，會自動生成下面就是一個類文件注釋頭：****************************************************************謀蕎摶篋飆鐸懟類蔣薔點鉍雜。 * 該類功能及其特點的描述（例如：該類是用來實現(xiàn)頁面調(diào)轉） * * 該類經(jīng)編譯測試過 * * （與該類相關聯(lián)的類）：（例如：） *** 開發(fā)公司或單位：中科院沈陽計算所有限公司西南信息中心** 版權：本文件版權歸屬中科院沈陽計算所有限公司** * （作者）：王悅邦 * * （該文件所支持的版本）：** （版本）： * * （開發(fā)日期）：20XX96** 最后更改日期：20XX126** 修改人：王悅邦** 復審人：**************************************************************廈礴懇蹣駢時盡繼價騷巹癩龔。文件注釋頭包括, , , , 等標記，是為了通過聲稱 標準文檔做準備的。煢楨廣鰳鯡選塊網(wǎng)羈淚鍍齊鈞。包的聲明與引用我們在做開發(fā)時常會引用（）核心類或者第三方軟件廠商的類，一般情況下，這些類都是封裝在一個包（）里面的，包概念的出現(xiàn)，使類（）有了名稱空間的細致劃分，使龐大復雜的類群有了較為清晰的分支，形成了清晰脈絡。包的另一個作用就是可以將同名的類（）或接口（）分離開來，不至于產(chǎn)生二義性或以假亂真的錯誤。鵝婭盡損鵪慘歷蘢鴛賴縈詰聾。下面給出了包的基本命名規(guī)則，之所以說是基本，是因為可以在特殊的情況下采用特殊的命名方法，凡事應具體情況具體分析。一般有如下規(guī)則：籟叢媽羥為贍僨蟶練淨櫧撻曉。包名應該是獨一無二不可重復的；包名通常情況下都應該是小寫字母；包名一般是公司域名的倒序，經(jīng)常用到的域名后綴有, , , , , ,
公司管理相關推薦
鄂ICP備17016276號-1