項目開發(fā)及編碼規(guī)范

1、工程開發(fā)標準文檔修訂歷史記錄日期版本說明作者2021-12-25初稿1.簡介目的1、用于標準指導開發(fā)組進行開發(fā)2、便于成員間的溝通與交流.3、有助于工程質量和穩(wěn)定.4、為后期維護提供支持2 .工程開發(fā)流程工程開發(fā)過程歸納分為以下步驟：1 .建立SVN工程版本限制.包括文檔,源碼, Lib包等.2 . 了解需求,并對需求文檔的書寫.見文檔結構規(guī)那么附錄.3 .詳細設計文檔.見文檔結構規(guī)那么附錄.功能模塊設計,重要模塊的算法設計.數(shù)據(jù)庫設計等.根據(jù)需求定義開發(fā)平臺及環(huán)境.4 .編碼.搭建開發(fā)平臺,配置開發(fā)環(huán)境.編碼.單元測試案例.5 .書寫軟件安裝手冊文件,數(shù)據(jù)庫腳本文件,以及考前須知releas

2、e notes.6 .交互測試組測試.根據(jù)測試組測試結果是否回歸第4步測試回歸最好不要超過2次.7 .測試通過,交付上線使用.維護手冊使用手冊3 .代碼標準Java代碼標準3.1.1 Java 類名類名可由：英文字母,數(shù)字,下劃線組成.數(shù)字,下劃線不能夠開頭類名由一個或者多個單詞組成.單詞通常要求簡潔明了達意.能夠通過類名能夠大致了 解此類的作用和用途.類名要求首字母大寫,多個單詞組成類名時,單詞的首字母要求大寫.建議：類名不要過于簡單或者太長.可以對單詞采用簡化的名稱：入：Number簡化為:num .3.1.2 Java 類結構類僅作為數(shù)據(jù)結構, 沒有行為,他封裝了一組或者相似的一些行為方

3、法.所以一個類盡量功能單一,或者功能類似共有行為的.一個類不要過于龐大.通常情況下：一般邏輯類中應該有構造方法和main方法,main方法中應該有測試代碼.每個類應該有toString 方法.3.1.2.1 包和引入語句在多數(shù)Java源文件中,第一個非注釋行是包語句.在它之后可以跟引入語句.報名的定義全部是小寫字母.具體定義依據(jù)工程而定.引入包時候,同一類型的歸納到一塊,用空行隔開.例如：import3.1.2 類注釋Java類開頭應該有相應的注釋：類版本描述,作者簽名,日期時間,公司備注,類的 功能作用相關描述等.詳細查看：注釋3.1.2.2 類成員變量a類變量要求放在類的開始聲明.一行聲明

4、一個.b變量名稱首字母要求小寫.其他命名規(guī)那么類似與類名.c static , final 類型的變量,字母要求全部大寫.d盡量在聲明局部變量的同時初始化.e防止局部變量和成員變量同名,覆蓋了成員變量.f盡量變量私有化,縮小變量的作用域.3.1.2.3 類成員方法a方法名命名規(guī)那么類似于成員變量命名規(guī)那么.b成員方法盡量私有化.d)方法與方法之間空一行分割,提升可讀性.c)方法盡可能有注釋：(詳細查看：注釋)e)方法盡可能盡早返回,結束.3.1.3 Java 語句3.1.3.1 縮進排版a) 4個空格(一個Tab建)常被作為縮進排版的一個單位.子模塊應該和父模塊保持一個 縮進單位.b)盡量防止

5、一行的長度超過80個字符.c)換行：當一個表達式無法容納在一行內時,可以依據(jù)如下一般規(guī)那么斷開之：- 在一個逗號后面斷開- 在一個操作符前面斷開- 寧可選擇較高級別(higher-level) 的斷開,而非較低級別(lower-level) 的斷開- 新的一行應該與上一行同一級別表達式的開頭處對齊- 如果以上規(guī)那么導致你的代碼混亂或者使你的代碼都堆擠在右邊,那就代之以縮進8個空格.如：someMethod(longExpression1, longExpression2, longExpression3, longExpression4, longExpression5);var = some

6、Method1(longExpression1, someMethod2(longExpression2, longExpression3);3.1.3.2 注釋Java 程序有兩類注釋：實現(xiàn)注釋 (implementation comments)和文檔注釋(documentcomments).實現(xiàn)注釋是使用/*.*/ 和.*/界定.文檔注釋可以通過javadoc工具轉換成HTML 文件.實現(xiàn)注釋用以描述實現(xiàn)的細節(jié),流程,和難點的描述.良好的實現(xiàn)注釋有助于自己和別人易于讀懂代碼.文檔注釋它可以被那些手頭沒有源碼的開發(fā)人員了解接口功能等.頻繁的注釋有時反映出代碼的低質量.當你覺得被迫要加注釋的時

7、候,考慮一下是否 可以重新設計該模塊的代碼結構或者邏輯,使其更清楚,而防止使用注釋提醒該模塊的實 現(xiàn),這樣往往都能夠提升代碼質量.注釋應被用來給出代碼的總括,良好的代碼里應該有大量的注釋.當然也要防止代碼 已經提供清楚明了,顯而易見注釋.注釋的格式：程序可以有4種實現(xiàn)注釋的風格：塊、單行、尾端和行末.分別由：/* notice */塊/* notice */單行/* notice */尾端2006-5-15. /modify by XXX2006-5-15 endtd. All right reserved.* 對系統(tǒng)標準化的異常處理.包含各種異常編碼,標準出錯提示與日志的產生和治理.* 異常

8、類型ID* 1-49:系統(tǒng)內部異常 一標準處理：寫日志,向客戶端拋出 CustomException異常* 50-99:用戶界面異常 一標準處理：寫日志,向客戶端拋出對應的自定義異常* 100以上：擴展異常* 注意：寫日志時應使用getSysMsg() 獲得對應的異常日志記錄串；向用戶端拋出的* 異常那么在getUserMsg()中攜帶應在界面上顯示的信息串* since 2001-12-18* author lijun* version* Copyright ? 2021 LinkCm Co. Ltd. All right reserved.*/過程和方法注釋與 JavaDoc中對應:3.1

9、.3.3 語句例如：a)簡單語句每行至多包含一條語句,例如：argv+; . )注意：空格不應該置于方法名與其左括號之間.這將有助于區(qū)分關鍵字和方法調用.- 空白應該位于參數(shù)列表中逗號的后面- 所有的二元運算符,除了 .,應該使用空格將之與操作數(shù)分開.一元操作符和操作 數(shù)之間不因該加空格,比方：負號 (-)、自增(+)和自減(-).例如：a += c + d;a = (a + b) / (c * d);while (d+ = s+) n+;) printSize(size is + foo + n);- for語句中的表達式應該被空格分開,例如： for (expr1; expr2; expr

10、3)- 強制轉型后應該跟一個空格,例如：myMethod(byte) aNum, (Object) x);myMethod(int) (cp + 5), (int) (i + 3) + 1);Jsp , JavaScript代碼標準3.2.1 Jsp 文件Jsp文件命名,首字母要求小寫,名稱可以用多個單詞組成.每個單詞組合時候首字母 大寫.建議：列表頁面為：表單展示頁面為：表單修改頁面為：Jsp文件的內容編碼格式 和 文件本身的編碼格式要求統(tǒng)一.具體視工程要求. 頁面盡量使用同一種標簽表達,比方只使用struts 標簽, 或者JSTL標簽.3.2.2 JavaScript 文件JavaScri

11、pt 腳本盡量建立獨立的以“js 為后綴的獨立文本文件.頁面單獨應用 js文件即可.文件命名與jsp文件相同.文件本身的編碼格式需要和整個工程文件編碼一致.一個js文件包含一個或者多個 function 函數(shù).數(shù)據(jù)庫對象定義標準3.3.1 表名命名規(guī)那么數(shù)據(jù)庫表的命名以是名詞的復數(shù)形式且都為大寫,如ACCOUNTINDICATOR_HISTORY如果表名由幾個單詞組成,那么單詞間用下劃線_分割,如 CURRENT_COUNTER 等表名盡量用全名表名限制在30個字符內.當表的全名超過 30字符時,可用縮寫來減少表名的長度, 如 description - desc ; information

12、- info ; address - addr 等 oracle 限制表名超過30個字符3.3.2 表字段名命名規(guī)那么字段名為小寫字段名為有意義的單詞,或單詞的縮寫如果字段由幾個單詞組成,那么單詞間用下劃線_分割,如client_id , post_code等字段名限制在30個字符內.當字段名超過30字符時,可用縮寫來減少字段名的長度,如 description - desc ; information - info ; address - addr 等3.3.3 索引命名規(guī)那么索引須根據(jù)IDX_table_, 其中是建立索引的表名,是建立索引的字段名索引名限制在30個字符內.當索引名超過30

13、字符時,可用縮寫來減少索引名的長度,如 description - desc; information - info ; address - addr3.3.4 主建、外鍵命名規(guī)那么主鍵根據(jù)PK_的規(guī)那么命名,其中為數(shù)據(jù)庫表名唯一鍵根據(jù)UK_的規(guī)那么命名,其中為數(shù)據(jù)塊表 名,為字段名外鍵根據(jù)FK_nn的規(guī)那么命名,其中為父表名,為子*用,為序列號Java命名規(guī)那么命名標準使程序更易讀,從而更易于理解.它們也可以提供一些有關標識符功能的信息,以助于理解代碼,例如,不管它是一個常量,包,還是類.標識符類型命名規(guī)那么例子前提* 盡量使用完整的英文描述符,米用適用于該領域的 術語* 采用大小寫混合使名

14、字可讀* 盡量少用縮寫,但如也可以使用公共常用的縮略語,如：HTML., IO.* 防止使用長的名字(小于 15個字母是個好主意)* 防止使用類似的名字,或者僅僅是大小寫不問的名 字、包(Packages)一個唯一包名的前綴總是全部小寫的ASCII字母并且金-個頂級域名,通常是 com, edu, gov, mil , net , org.包名的后續(xù)局部根據(jù)不同機構各自內部的 命名標準而不盡相同.這類命名標準可能以特定目錄名的組成來區(qū)分部 門(department),項 目 (project) , 機器(machine), 或注冊名(login names) o類(Classes)命名規(guī)那么：

15、類名是個一名詞,米用大小寫混合的方式, 每個單詞的首字母大寫. 盡量使你的類名簡潔而富于 描述.使用完整單詞,防止縮寫詞(除非該縮寫詞被 更廣泛使用,像 URL HTML)class Raster;class ImageSprite;接 口(Interfaces)命名規(guī)那么：大小寫規(guī)那么與類名相似interfaceRasterDelegate;interface Storing;方法(Methods)方法名是一個動詞, 采用大小寫混合的方式, A 個 單詞的首字母小寫,其后單詞的首字母大寫.run();runFast();getBackground();變量(Variables)除了變量名外,

16、所有實例,包括類,類常量,均采用大小寫混合的方式, 第一個單詞的首字母小寫, 其后char c;int i;float myWidth;單詞的首字母大寫.變量名不應以下劃線或美兀符號 開頭,盡管這在語法上是允許的.變量名應簡短且富于描述.變量名的選用應該易于記 憶,即,能夠指出其用途. 盡量防止單個字符的變量 名,除非是一次性的臨時變量. 臨時變量通常被取名 為i , j , k, m和n,它們一般用于整型； c, d, e, 它們一般用于字符型.實例變量(Instance Variables)大小寫規(guī)那么和變量名相似,除了前面需野-個下劃線int _employeeId; String _n

17、ame;Customer _customer;常量(Constants)類常量和ANSI常量的聲明,應該全部大寫,單詞間 用卜劃線隔開.盡量防止ANSI常量,容易引起錯誤static final int MIN_WIDTH = 4;staticfinalintMAX_WIDTH = 999;staticfinalintGET_THE_CPU = 1;4.開發(fā)平臺及工具.平臺工程定義具體開發(fā)平臺和工具視不同的工程需求而定.同一工程組的開發(fā)平臺要求盡量統(tǒng)對應J2EE開發(fā)平臺定義如以下表:環(huán)境資源工程名稱版本說明操作系統(tǒng)Windows XPJDKIDEEclipse開源框架及工具應用效勞器Tomca

18、t版本限制SVN其他資源版本限制工具在沒有特殊要求外,要求使用TortoiseSVN工具.TortoiseSVN是Subversion 版本限制系統(tǒng)的一個免費開源客戶端,可以超越時間的管理文件和目錄.文件保存在中央版本庫,除了能記住文件和目錄的每次修改以外,版本庫非常像普通的文件效勞器.你可以將文件恢復到過去的版本,并且可以通過檢查歷史知道數(shù)據(jù)做了哪些修改,誰做的修改.4.1.1 SVN使用方式：一：一是簡單使用,即建立一個主干工程目錄,各個開發(fā)成員同時使用這個主干目錄進行直接修改與更新.二：二是建立工程主干,和各個開發(fā)成員的分支目錄.(1).各開發(fā)成員建立自己的分支,并在此分支上開發(fā)；(1).各開發(fā)成員把分支合并到主干上并形成較為穩(wěn)定的版本；(1).各個成員重新從主干上建立新的分支,在此分支上開發(fā)(即回到第一步)(1).循環(huán)往復,直到工程結束.目前使用是的一種方式.4.1.1