培訓講義–開發規範(01_02)

前一篇文章中對於團隊做了講解,(文章參照)
針對Coding 的培訓中,關於開發規範部分的PPT內容,
開發規範的作用
   1)開發規範作用於團隊開發內部，保證不同的開發人員在工作環境設定，代碼開發規範以及日常開發的行為能夠達到共通的要求。
   2)開發規範用於開發的各個階段，保證開發中的各個問題能夠按照開發制定的標準進行處理（比如：代碼管理，版本衝突，代碼命名規範等等）。
   3)開發規範作為最終開發產品代碼的檢測標準,通過對最終產品代碼的再次檢測，來保證代碼的規範性，可維護性。
開發規範作為開發中的檢測標準，來約束開發人員的開發行為，達到在團隊內部提高開發品質和減少開發成本的作用。

開發規範的要求
   1)制定開發時要求對於要求的內容必須語義清晰，確保所制定的內容不會有歧義發生。
   2)對於開發中說明性的內容，以圖片說明為主，減少文字性的描述。
   3)對於開發規範避免在項目開發後發生對代碼命名，代碼邏輯分層等部分內容的變更。
   4)如果開發規範發生變更，確保項目團隊內部所有的人員都按照最新的開發標準進行開發。
   5)對於開發規範也要求進行版本管理。

開發規範的內容
   作為一份比較理想的開發規範，必須具備有以下的開發內容：
   1)開發平台的約定
      a)開發作業系統環境和最總使用者使用環境（包含ServicePack版本號碼）
      b)開發工具版本
      c)資料庫類型已經版本
      d)網路狀態
      e)版本控制工具
      f)開發使用硬體環境和組成
      g)開發規範的執行問題
   2)工作方式的約定
      a)開始工作前的行為（每天開始工作先update代碼）
      b)工作結束後的行為（每天結束後需要commit全部代碼）
      c)版本控制行為（代碼commit的要求和發生衝突的解決辦法）
      d)檔案儲存要求（新增代碼檔案和備份檔案的處理）
   3)代碼書寫約定
      a)代碼的命名規則
      b)代碼的注釋要求
      c)代碼的修改履曆要求
      d)代碼的檔案儲存要求（一個類儲存在一個檔案中等）
      e)代碼的外觀要求（代碼的對齊，換行要求）
      f)資料庫代碼的書寫要求
    4)程式的結構約定
      a)通用代碼的處理方式
      b)介面的處理方式
      c)代碼的內部的邏輯劃分要求
      d)程式的分層結構要求
      e)程式的異常處理要求
    5)協助工具輔助的使用約定
      a)版本控制工具使用說明
      b)代碼產生工具的使用說明
      c)單元測試工具的使用說明
      d)Bug管理工具的使用說明
    6)其他約定
      a)單元測試方法約定
      b)版本控制約定
      c)計劃管理約定
      d)測試資料的約定

開發規範的執行問題
    1)制定問題
      a)鼓勵全部的項目開發人員都參與規範的制定
      b)制定標準是需要考慮代碼的維護性和實際開發的便利性
    2)執行問題
      a)依照開發規範對於代碼進行檢測，對於存在問題要求修正。
      b)通過團隊內部人員交叉檢測的方式來執行開發標準