1、3/3/2022編輯ppt1軟件項目管理培訓講座軟件項目管理培訓講座系列之四系列之四代碼管理規(guī)范代碼管理規(guī)范3/3/2022編輯ppt2內容提要內容提要代碼管理的作用和內容代碼管理的作用和內容代碼編寫與調試的規(guī)范代碼編寫與調試的規(guī)范代碼控制與管理的規(guī)范代碼控制與管理的規(guī)范3/3/2022編輯ppt3代碼管理的作用代碼管理的作用代碼代碼軟件功能和性能的核心軟件功能和性能的核心流程與結構，軟件功能的基礎流程與結構，軟件功能的基礎算法與接口，軟件性能的基礎算法與接口，軟件性能的基礎安全與穩(wěn)定，軟件維護的基礎安全與穩(wěn)定，軟件維護的基礎代碼代碼產品升級和系統(tǒng)維護的對象產品升級和系統(tǒng)維護的對象代碼注釋與說

2、明，提高軟件的可復用性代碼注釋與說明，提高軟件的可復用性系統(tǒng)設計與結構，提高功能的可擴展性系統(tǒng)設計與結構，提高功能的可擴展性版本控制與備份，保持軟件團隊的價值版本控制與備份，保持軟件團隊的價值3/3/2022編輯ppt4軟件開發(fā)的藝術性分析軟件開發(fā)的藝術性分析一種需求可用多種思路實現(xiàn)一種需求可用多種思路實現(xiàn)不同的系統(tǒng)平臺、不同的應用環(huán)境不同的系統(tǒng)平臺、不同的應用環(huán)境一種思路可用多種方法實現(xiàn)一種思路可用多種方法實現(xiàn)千差萬別的算法思想千差萬別的算法思想一種方法可用多種工具實現(xiàn)一種方法可用多種工具實現(xiàn)C/C+C/C+、Visual BasicVisual Basic、DelphiDelphi、ASP

3、ASP、C#C#一種實現(xiàn)可用多種方法評測一種實現(xiàn)可用多種方法評測黑盒測試、白盒測試、壓力測試、安全測試黑盒測試、白盒測試、壓力測試、安全測試軟件開發(fā)的藝術性不確定性軟件開發(fā)的藝術性不確定性規(guī)范的代碼折射相同的思想規(guī)范的代碼折射相同的思想3/3/2022編輯ppt5代碼管理的內容代碼管理的內容代碼編寫規(guī)范代碼編寫規(guī)范變量命名與數(shù)據(jù)結構定義變量命名與數(shù)據(jù)結構定義空格、括號、空格、括號、TabTab的使用的使用注釋、說明的使用注釋、說明的使用代碼調試習慣代碼調試習慣如何增加調試輸出或添加調試開關？如何增加調試輸出或添加調試開關？如何保證調試過程的穩(wěn)定？如何保證調試過程的穩(wěn)定？代碼提交規(guī)范代碼提交規(guī)范

4、版本的定義與應用版本的定義與應用代碼的集中管理，代碼的集中管理，Check in/Check outCheck in/Check out代碼維護習慣代碼維護習慣影響代碼運行的環(huán)境因素影響代碼運行的環(huán)境因素影響代碼性能的工作方法影響代碼性能的工作方法3/3/2022編輯ppt6對代碼管理的認識誤區(qū)對代碼管理的認識誤區(qū)誤區(qū)誤區(qū)1 1：代碼體現(xiàn)個人風格，統(tǒng)一規(guī)范扼殺創(chuàng)造性：代碼體現(xiàn)個人風格，統(tǒng)一規(guī)范扼殺創(chuàng)造性騎士時代的落后觀點騎士時代的落后觀點團隊遠比個人重要團隊遠比個人重要誤區(qū)誤區(qū)2 2：代碼風格只是個人習慣，無需刻意統(tǒng)一：代碼風格只是個人習慣，無需刻意統(tǒng)一軟件價值觀點：代碼也是一種商品，統(tǒng)一規(guī)格

5、很重要軟件價值觀點：代碼也是一種商品，統(tǒng)一規(guī)格很重要軟件出口觀點：歐美市場、日本市場都要求規(guī)范代碼軟件出口觀點：歐美市場、日本市場都要求規(guī)范代碼誤區(qū)誤區(qū)3 3：代碼規(guī)范只是細枝末節(jié)，提高精妙程度才重要：代碼規(guī)范只是細枝末節(jié)，提高精妙程度才重要天才培養(yǎng)模式和螞蟻工場模式：規(guī)范勝于精妙天才培養(yǎng)模式和螞蟻工場模式：規(guī)范勝于精妙武林高手與前軍萬馬：還記得郭靖和楊過嗎？武林高手與前軍萬馬：還記得郭靖和楊過嗎？誤區(qū)誤區(qū)4 4：代碼規(guī)范只是規(guī)定如何編寫代碼：代碼規(guī)范只是規(guī)定如何編寫代碼代碼規(guī)范包括編寫代碼、維護代碼和管理代碼代碼規(guī)范包括編寫代碼、維護代碼和管理代碼代碼思想良好的文字作品代碼思想良好的文字作品

6、3/3/2022編輯ppt7內容提要內容提要代碼管理的作用和內容代碼管理的作用和內容代碼編寫與調試的規(guī)范代碼編寫與調試的規(guī)范代碼控制與管理的規(guī)范代碼控制與管理的規(guī)范3/3/2022編輯ppt8代碼編寫規(guī)范的內容代碼編寫規(guī)范的內容命名規(guī)范命名規(guī)范如何定義代碼文件名與模塊名如何定義代碼文件名與模塊名如何定義變量與數(shù)據(jù)結構名稱如何定義變量與數(shù)據(jù)結構名稱如何定義函數(shù)名與接口名稱如何定義函數(shù)名與接口名稱語句編寫規(guī)范語句編寫規(guī)范TabTab、空格、括號的使用、空格、括號的使用語句排列與空行語句排列與空行代碼注釋規(guī)范代碼注釋規(guī)范文件頭注釋與函數(shù)頭注釋文件頭注釋與函數(shù)頭注釋函數(shù)內部注釋函數(shù)內部注釋3/3/20

7、22編輯ppt9案例分析案例分析代碼編寫規(guī)范示例代碼編寫規(guī)范示例代碼片斷示例代碼片斷示例分析和總結分析和總結良好的代碼規(guī)范是團隊精神和職業(yè)素養(yǎng)的體現(xiàn)良好的代碼規(guī)范是團隊精神和職業(yè)素養(yǎng)的體現(xiàn)習慣的培養(yǎng)是保證團隊成功的關鍵習慣的培養(yǎng)是保證團隊成功的關鍵3/3/2022編輯ppt10代碼編寫的工程習慣代碼編寫的工程習慣習慣習慣1 1：使用空格和空行，增進易讀性：使用空格和空行，增進易讀性習慣習慣2 2：注重多重嵌套語句的起止注釋：注重多重嵌套語句的起止注釋習慣習慣3 3：避免使用過于復雜、難懂的算法：避免使用過于復雜、難懂的算法習慣習慣4 4：盡可能不要使用遞歸：盡可能不要使用遞歸3/3/2022編

8、輯ppt11代碼調試規(guī)范的內容代碼調試規(guī)范的內容如何盡可能的減少出錯概率？如何盡可能的減少出錯概率？增加對數(shù)據(jù)合法性的檢查增加對數(shù)據(jù)合法性的檢查增加對各類異常的處理增加對各類異常的處理增加關鍵處理步驟的調試輸出增加關鍵處理步驟的調試輸出代碼調試規(guī)范代碼調試規(guī)范出錯控制機制的設計：出錯控制機制的設計：Error CodeError Code如何定義如何定義調試輸出機制的設計：如何調試輸出機制的設計：如何OutputOutput、ReturnReturn調試代碼的編寫規(guī)范調試代碼的編寫規(guī)范3/3/2022編輯ppt12如何減少出錯概率如何減少出錯概率示例示例1 1：計算窗口的寬高比：計算窗口的寬高

9、比usWHRatio = usWeight / usHeight;usWHRatio = usWeight / usHeight;可能出錯的機會：除零錯可能出錯的機會：除零錯如何保證出錯概率少？如何保證出錯概率少？示例示例2 2：如何處理各類可能的異常：如何處理各類可能的異常返回值控制：返回值控制：Error Code Error Code C+C+中的中的CatchTryCatchTry應用應用應用界面中的消息框應用界面中的消息框3/3/2022編輯ppt13代碼調試規(guī)范代碼調試規(guī)范如何設計如何設計Error Code Error Code Error CodeError Code的定義規(guī)則

10、的定義規(guī)則Error CodeError Code的使用規(guī)則的使用規(guī)則Error CodeError Code的分析規(guī)則的分析規(guī)則如何添加調試代碼和調試輸出如何添加調試代碼和調試輸出預編譯宏定義的使用：代碼運行的開關預編譯宏定義的使用：代碼運行的開關調試輸出的設計：文件輸出和界面輸出調試輸出的設計：文件輸出和界面輸出調試代碼運行控制：調試代碼運行控制：DebugDebug版和版和ReleaseRelease版版3/3/2022編輯ppt14內容提要內容提要代碼管理的作用和內容代碼管理的作用和內容代碼編寫與調試的規(guī)范代碼編寫與調試的規(guī)范代碼控制與管理的規(guī)范代碼控制與管理的規(guī)范3/3/2022編輯

11、ppt15代碼控制的規(guī)范代碼控制的規(guī)范軟件開發(fā)的分工軟件開發(fā)的分工 每一個模塊、文件均指定固定人員每一個模塊、文件均指定固定人員首要的工作是確定接口首要的工作是確定接口次要的工作是確定數(shù)據(jù)結構和相關常量定義次要的工作是確定數(shù)據(jù)結構和相關常量定義代碼權限的控制代碼權限的控制應用應用VSSVSS建立代碼管理環(huán)境建立代碼管理環(huán)境針對針對ProjectProject分配合理的權限分配合理的權限保證每個人規(guī)范的使用保證每個人規(guī)范的使用Check in/Check outCheck in/Check out3/3/2022編輯ppt16代碼控制的常見錯誤代碼控制的常見錯誤重復分工的危害重復分工的危害 多人

12、同時寫一個文件或一個函數(shù)造成沖突多人同時寫一個文件或一個函數(shù)造成沖突多人多人Check in/Check out Check in/Check out 造成代碼丟失造成代碼丟失資源的重復投入和浪費資源的重復投入和浪費不注重權限和版本的危害不注重權限和版本的危害無法重復、永遠丟失的代碼無法重復、永遠丟失的代碼無法跟蹤、無法重現(xiàn)的錯誤無法跟蹤、無法重現(xiàn)的錯誤無法控制、無法管理的團隊無法控制、無法管理的團隊3/3/2022編輯ppt17案例剖析案例剖析代碼管理示范代碼管理示范VSSVSS的架構示例的架構示例 建立目錄結構、增加管理文件建立目錄結構、增加管理文件分配權限、添加版本控制分配權限、添加版本控制VSSVSS的應用示例的應用示例如何如何Check