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