由於自己需要帶領團隊同仁開發軟體並建立協作機制，提高程式碼的可讀性與開發效率

故根據過往的經驗和方法擬定了寫作規範，提供給一起協作的夥伴參考與執行

一旦協作規範的機制建立完備後，除了能讓同仁之間互相快速檢視程式碼內文，來降低邏輯錯誤外

也可以彼此互相督促寫作結果，落實Code Review的精神

希望大家都能從技術債中解放 m^(_ _)^m

• 寫作規範目的

為了方便協作者能更容易、快速地理解程式碼邏輯並進入開發狀態。

使開發團隊在閱讀/撰寫程式碼時能統一風格和表達方式，以降低同仁閱讀並理解程式碼的成本。

• 寫作時的核心觀念

  • 邏輯一致性
    • 避免程式碼前後文因邏輯或表達語意的不同，進而導致前後邏輯不一致而不順暢
  • 可讀性
    • 提高同仁對於程式碼的理解效率，在閱讀過程中降低理解程式的時間成本
  • 具可解釋性
    • 程式碼的變數與方法的命名具有其意義性，可以通過其命名了解變數或方法的具體功能和意義
  • 單一功能最小化
    • 避免龐大的商用邏輯交錯呈現，導致程式碼閱讀的過程出現理解與記憶困難
    • 實作單元測試時的必要設計，將功能權責劃分清楚，盡可能單純化
  • 文件寫作縮排
    • 適度的縮排有助於理解程式碼區段，提高閱讀效率
  • 程式碼檔案的文字編碼格式(UTF-8)
    • 避免跨系統、跨編輯器時可能產生的非英語系文字因為字碼轉換而變成亂碼的問題
  • 簡單扼要的表達方法
    • 程式碼內容閱讀起來盡可能簡單扼要、邏輯清楚，能夠透過內文就了解該程式的開發目的和計算過程
  • 符合SOLID設計原則
    • 貫徹OOP精神，透過程式架構的設計乃至物件的結構，來提高程式碼的穩定度、擴充彈性

• 具體實踐策略

1. 統一的命名方式
2. 讓人能夠一目了然的表達語句
3. 使用駝峰式命名法而非匈牙利命名法
4. 使用Visual Studio內建的文件排版工具 (Ctrl+K + Ctrl+D)