軟件團隊的開發(fā)與合作規(guī)范ppt課件

1、軟件工程開發(fā)規(guī)范.培訓目的 開發(fā)規(guī)范培訓的目的是為了保證在系統(tǒng)設計、編碼、測試、維護的過程中工程組人員遵照一套一致系統(tǒng)設計規(guī)范、運用程序編寫規(guī)范、頁面風格規(guī)范，借以提高軟件開發(fā)團隊的效率、添加代碼的一致性、可讀性，可維護性，保證工程開發(fā)穩(wěn)定。 本次培訓提供了工程開發(fā)的各項規(guī)范以及指點原那么。開發(fā)人員在開發(fā)過程中必需嚴厲遵守此開發(fā)規(guī)范。 .開發(fā)規(guī)范參考資料想要更深化了解本次培訓涉及到背景知識，可訪問以下網站。SUN的官方網站：java.sun IBM官方網站：www-900.ibm/developerWorks關于代碼規(guī)范規(guī)范可參閱：Java Programming Style Guide ja

2、varanch/style.jspAmbySoft Inc. Coding Standards for Java v17.01d ambysoft/javaCodingStandards.htmlCode Conventions for the JavaTM Programming Language java.sun/docs/codeconv/html/CodeConvTOC.doc.html.開發(fā)人員角色 開發(fā)組長：控制團隊開發(fā)，只需在開發(fā)組長的授權下，才可進展根底開發(fā)包的變動。設計人員：擔任詳細設計?？煽刂频奈臋n：各種方式的設計文件, 包括用例圖，流程圖等。編程人員：擔任程序開發(fā)?？煽刂?/p>

3、的文檔：程序源代碼。整合人員：擔任運用程序內部模塊與模塊之間的整合，以及運用程序與運用平臺之間的整合?？煽刂频奈臋n：程序開發(fā)包，系統(tǒng)配置文件。部署人員：擔任運用程序的部署，同時擔任運用效力器的維護?？煽刂频奈臋n：部署描畫文件。數據庫管理員：擔任數據庫的維護，調優(yōu)?？煽刂频奈臋n：數據庫腳本。測試人員：擔任程序的測試任務，可控制的文檔：測試報告。在開發(fā)過程中，每個人可同時兼任數個角色，并進展角色轉換。 .開發(fā)環(huán)境 應用程序服務器：IBM WebSphere Application Server 6.1數據庫：DB2 9.0開發(fā)工具：JAVA IDEEclipse 頁面開發(fā)Editplus*、Dre

4、amWeaver*版本控制工具：VSS.軟件環(huán)境搭建過程第1步：安裝DB2； 第2步：安裝WebSphere；第3步：安裝ResourceOne； 第4步：安裝VSS；第5步：從VSS中下載運用程序的開發(fā)包，包括目錄構造、基類，第三方開發(fā)包；第6步：將運用程序開發(fā)包部署進WebSphere ； .Java程序 命名規(guī)范包名：Package 的名字應該都是由小寫單詞組成。如test.demo.example 。文件名 ：文件名由英文單詞組成，每個單詞的首字母大寫，不要超越4個單詞，如ShipOrder.java。Java文件的文件名要與程序中的public類名一樣。Servet文件要以Servl

5、et做為結尾，如AddCompanyServlet.java訪問數據庫的Bean要以DBBean為結尾，如AddCompanyDBBean.java .Java程序 命名規(guī)范類名 ：Class 的名字必需由大寫字母開頭而其他字母都小寫的單詞組成變量名：Class 變量的命名 ：變量的名字必需用一個小寫字母開頭。后面的單詞用大寫字母開頭。 Static Final 變量的命名 ：Static Final 變量的名字應該都大寫，并且指出完好含義。用有意義的名字命名變量 。首先，用完好的英語單詞或商定俗成的簡寫命名他的變量(不允許用漢語拼音)，如： firstName，zipCode用復數命名col

6、lection類變量。ollection包括數組，vector等。命名時運用復數： customers ，classmates方法名：方法的名字必需用一個小寫字母開頭。后面的單詞用大寫字母開頭。方法的名字要與該方法的用途相關。 .Java程序 命名規(guī)范參數名 ：參數的命名 ：參數的名字必需和變量的命名規(guī)范一致。 方法的參數 ：運用有意義的參數命名，假設能夠的話，運用和要賦值的字段一樣的名字。.Java程序 命名規(guī)范增刪改程序和頁面的調用關系和文件名 .Java程序 命名規(guī)范增刪改程序和頁面的調用關系和文件名 AddOrderServer, SaveOrderServer, DeleteOrde

7、rServlet不需求頁面，其他有JSP頁面的Servlet要與JSP文件名相對應。OrderDetailServet對應兩個JSP文件，EditOrder用于可編輯形狀，ShowOrder用于不可編輯形狀。AddOrderServlet和SaveOrderServlet的前往頁面可以是List頁面，也可以是Detail頁面，假設當前人已完成一切可進展的操作，那么回到List頁面，假設未完成，那么回到Detail頁面。 .Java程序 代碼格式文件頭 ：版權信息 版權信息必需在 java 文件的開頭，比如：/* 類名* 日期* 修正記錄* Copyright ICSS 2003* All ri

8、ght reserved.*/其他不需求出如今 javadoc 的信息也可以包含在這里。Package/Imports package 行要在 import 行之前，import 中規(guī)范的包名要在本地的包名之前，而且按照字母順序陳列。假設 import 行中包含了同一個包中的不同子目錄，那么應該用 * 來處置。對于import語句，假設某一個包中援用的類不超越三個包括三個，不允許用import xxx.*;格式。將import的classes歸類，按順序羅列： a. Java規(guī)范類(java.*) b. Java擴展類(javax.*) c. 第三方類 d. 他的運用程序的類.Java程序 代

9、碼格式縮進 縮進應該是每行4個空格，不要在源文件中保管Tab字符。 在運用不同的源代碼管理工具時Tab字符將由于用戶設置的不同而擴展為不同的寬度。注釋 為保證開發(fā)后JAVA DOC的順利生成，開發(fā)人員必需在一切方法，全局變量前參與加上規(guī)范JAVA注釋。類注釋需求包含以下要素：方法描畫參數： param 參數名 闡明前往值： return 闡明例外情況：exception 完好類名 闡明/* this is a doc sample* param args array of string arguments* return No return value* exception exception

10、 No exceptions thrown */頁寬 頁寬應該設置為80字符， 源代碼普通不會超越這個寬度， 并導致無法完好顯示， 但這一設置也可以靈敏調整。 在任何情況下， 超長的語句應該在一個逗號或者一個操作符后折行， 一條語句折行后， 應該比原來的語句再縮進2個字符。.HTML/JSP 代碼規(guī)范文件頭文件頭要寫明該文件的用途，及修正記錄。如：! 文件名：OrderList.jsp 闡明：訂單列表 修正記錄：2003-08-24，張三，添加一個按鈕縮進 HTML標志層次之間的縮進為2個字符，Java代碼的縮進為4個字符，文件中不要有Tab符號，都要交換為空格。 .Java編程技巧 exit

11、() exit 除了在 main 中可以被調用外，其他的地方不應該調用。由于這樣做不給任何代碼代碼時機來截獲退出。一個類似后臺效力地程序不應該由于某一個庫模塊決議了要退出就退出。 異常 聲明的錯誤應該拋出一個RuntimeException或者派生的異常。 頂層的main()函數應該截獲一切的異常，并且打印或者記錄在日志中在屏幕上。 .Java編程技巧渣滓搜集 JAVA運用成熟的后臺渣滓搜集技術來替代援用計數。但是這樣會導致一個問題：他必需在運用完對象的實例以后進展清場任務。比如一個prel的程序員能夠這么寫： .FileOutputStream fos = new FileOutputStr

12、eam(projectFile);project.save(fos, IDE Project File); . 除非輸出流一出作用域就封鎖，非援用計數的程序文語，比如JAVA，是不能自動完成變量的清場任務的。必需象下面一樣寫： FileOutputStream fos = new FileOutputStream(projectFile);project.save(fos, IDE Project File); fos.close();.Java編程技巧Clone 下面是一種有用的方法： implements CloneablepublicObject clone()try ThisClass

13、 obj = (ThisClass)super.clone();obj.field1 = (int)field1.clone();obj.field2 = field2;return obj; catch(CloneNotSupportedException e) throw new InternalError(Unexpected CloneNotSUpportedException: + e.getMessage();.Java編程技巧運用 StringBuffer 對象 在處置 String 的時候要盡量運用 StringBuffer 類，StringBuffer 類是構成 String

14、 類的根底。String 類將 StringBuffer 類封裝了起來，以破費更多時間為代價為開發(fā)人員提供了一個平安的接口。當我們在構造字符串的時候，我們應該用 StringBuffer 來實現大部分的任務，當任務完成后將 StringBuffer 對象再轉換為需求的 String 對象。比如：假設有一個字符串必需不斷地在其后添加許多字符來完成構造，那么我們應該運用 StringBuffer 對象和她的 append() 方法。假設我們用 String 對象替代 StringBuffer 對象的話，會破費許多不用要的創(chuàng)建和釋放對象的 CPU 時間。 防止太多的運用 synchronized 關

15、鍵字 防止不用要的運用關鍵字 synchronized，應該在必要的時候再運用她，這是一個防止死鎖的好方法。 換行 假設需求換行的話，盡量用 println 來替代在字符串中運用n。 他不要這樣： System.out.print(Hello,world!n); 要這樣： System.out.println(Hello,world!); 或者他構造一個帶換行符的字符串，至少要象這樣： String newline = System.getProperty(line.separator); System.out.println(Hello world + newline); .數據庫規(guī)范 數據庫設計時，應按照關系數據庫的建模理念，滿足設計范式。在構造物理實體時，應參照DB2性能手冊，優(yōu)化DB2性能。 第一種規(guī)范方式：表中的每一行和每一列均有一個值，永遠不會是一組值。 第二種規(guī)范方式：不在關鍵字中的每一列提供取決于整個關鍵字的現實。 第三種規(guī)范方式：每個非關鍵字列提供與其他非關鍵字列無關并只取決于該關鍵字的現實。 第四種規(guī)范方式：沒有行包含有關一個實體的兩個或更多個獨立的多值現實。 每種范式均運用于特定條件。 .LOG記錄規(guī)范級別(Level)：輸出日志的重要程度，便于控制日志輸出的多少。輸出目的地(Appender)：日志可以被寫入的存儲空間，常見的有控制臺、文件