j2ee項(xiàng)目代碼規(guī)范文檔(更新版)
【正文】 行規(guī)則代碼行長度一般來說的代碼行長度應(yīng)該小于個(gè)字符，超過這個(gè)長度可能在一些開發(fā)工具或編譯器上就無法很好地顯示，而且也會(huì)給閱讀程序帶來麻煩。表 類與接口的聲明序號(hào)類與接口的聲明聲明規(guī)則類與接口文件頭的注釋應(yīng)采用（**…*）的注釋格式具體的書寫格式及其內(nèi)容，參考部分類與接口的聲明類與接口的名字一般由大寫字母開頭，其他字母都小寫的單詞組成，并且類的名字應(yīng)盡量具有清晰的實(shí)際意義類與接口實(shí)現(xiàn)部分的注釋應(yīng)采用（*…*）的注釋格式這種注釋方式一般適用于類的接口中較大區(qū)域的注釋，而對(duì)類與接口文件頭的注釋，則不適用類的變量的聲明首先應(yīng)該聲明公共（）類型的變量，再聲明保護(hù)（）類型的變量，最后聲明私有（）類型的變量實(shí)例（）變量的聲明與類的變量聲明順序一樣，首先應(yīng)該聲明公共（）類型的變量，再聲明保護(hù)（）類型的變量，最后聲明私有（）類型的變量構(gòu)造器（）的聲明構(gòu)造器一般作為類的第一個(gè)方法聲明，你可以在構(gòu)造器的聲明體中加入一些與處理代碼方法（）的聲明方法的聲明最好采用以功能性分組的方式進(jìn)行排列，這比采用可訪問性分組的方式排列更為友好，例如：可以將一個(gè)私有方法放在兩個(gè)公共方法之間，這樣做是為了把功能性相近的方法排列在一個(gè)組中。一般情況下源文件的第一行都是類本身的包名描述部分（如果有包名的話）。煢楨廣鰳鯡選塊網(wǎng)羈淚鍍齊鈞。如表所示。文件注釋頭.包的聲明與引用.類與接口的聲明源文件編排格式.代碼行長度與折行規(guī)則.代碼行長度.折行規(guī)則.程序注釋.程序?qū)崿F(xiàn)代碼注釋.注釋規(guī)則.變量的聲明初始化與放置.變量聲明.變量初始化.變量放置程序語句編寫規(guī)則.簡單語句.復(fù)合語句.空格與空行的應(yīng)用規(guī)則.空格的應(yīng)用規(guī)則.空行的應(yīng)用規(guī)則.方法、變量與常量的命名規(guī)則.方法的命名規(guī)則.變量的命名規(guī)則.常量的命名規(guī)則序通常說來優(yōu)秀的開發(fā)人員一般都有良好的程序設(shè)計(jì)風(fēng)格，優(yōu)秀的管理人員會(huì)在自己的開發(fā)團(tuán)隊(duì)中灌輸養(yǎng)成良好程序設(shè)計(jì)風(fēng)格的意識(shí)，優(yōu)秀的軟件企業(yè)都有自己一套健全、成熟的程序設(shè)計(jì)風(fēng)格規(guī)范文檔，用以規(guī)范開發(fā)人員編寫代碼的風(fēng)格。每一個(gè)源文件一般由下面的順序構(gòu)成：（）文件注釋頭（）包名（）（）引入（）聲明（）類（）或接口（）的聲明部分文件注釋頭類文件注釋頭是用來描述該類功能及其特點(diǎn)，以及相關(guān)開發(fā)信息的，如該類的關(guān)聯(lián)類（通常情況下不描述系統(tǒng)核心類如, 等）、開發(fā)公司或單位、版權(quán)、作者、代碼審定人該類所支持的版本、該類版本、開發(fā)日期、最后更改日期、修改人、復(fù)審人等信息。鵝婭盡損鵪慘歷蘢鴛賴縈詰聾。 。擁締鳳襪備訊顎輪爛薔報(bào)贏無。壇摶鄉(xiāng)囂懺蔞鍥鈴氈淚躋馱釣。運(yùn)算符前折行與高層折行優(yōu)于低層折行實(shí)例。鍬籟饗逕瑣筆襖鷗婭薔嗚訝擯。塊注釋代碼塊注釋經(jīng)常被用于提供文件、方法、數(shù)據(jù)結(jié)構(gòu)、變量的意義與用途，以及算法的描述。塊注釋以“*”開始，以“*”終結(jié)，例如：識(shí)饒鎂錕縊灩筧嚌儼淒儂減攙。單獨(dú)行注釋一般用于對(duì)較短的注釋信息的描述。 *否則返回假* }……類注釋與注釋在方法的上方注釋對(duì)此方法的描述、返回值。 } { 39。 ()。 {*** （方法注釋）錄入事故基本信息* 版本后開始使用* * * 事故基本信息* 保存成功與否標(biāo)志*( ){** （塊注釋）生成事故記錄編號(hào)* ()。 部門人數(shù)如果變量名稱較短并且又是同一數(shù)據(jù)類型，下面的聲明方式也是可以接受的： , 。 *代碼段起始部位*…} }……這個(gè)規(guī)則的一個(gè)例外就是在循環(huán)語句中可以直接聲明變量，如下所示：…… ( 。()。} {。 :。 。結(jié)構(gòu)異常處理結(jié)構(gòu)異常處理是較為普通常用的異常處理方法，其標(biāo)準(zhǔn)格式如下所示： {。空格的應(yīng)用規(guī)則關(guān)鍵字之后要留有空格，如關(guān)鍵字與括號(hào)之間。賦值操作符、比較操作符、算術(shù)操作符、邏輯操作符，如“”、“”、“”、“”、“”、“*”、“”、“”、“”、“”、“^”等操作符的前后應(yīng)當(dāng)加空格。驍顧燁鶚巰瀆蕪領(lǐng)鱺賻驃弒綈。另外單字符的變量名應(yīng)該盡量避免，除非臨時(shí)變量，例如，一些證書單字符臨時(shí)變來那個(gè)：，等以及單字符變量：，等，如下所示：鎦詩涇艷損樓紲鯗餳類礙穡鰳
公司管理相關(guān)推薦
鄂ICP備17016276號(hào)-1