一、程式碼規範
良好風格源於統一規範。微軟統計:印度工程師同類模組代碼一致性 70-80%,中國工程師僅 20%,亟待改善。
1. 語義命名
- 類別、變數、常數、方法皆使用對應英文實義命名
- 多單詞組合:下底線分隔(如
hello_world)或 PascalCase(HelloWorld)
- 超過 30 字元:取發音重音節縮寫(如 Repeater→rpt, Management→mgt)
2. 大小寫規則
| 規則 | 適用對象 | 範例 |
| PascalCase | 類別、方法、屬性、常數 | HelloWorld, SayHello, TotalCount |
| camelCase | 區域變數、方法參數、私有欄位 | totalCount, fullMessage, name |
3. 命名禁忌
- ❌ 匈牙利命名法(如
m_sName, nAge)
- ❌ 單字母變數(
i, n, x),迴圈計數器除外
- ❌ 縮寫不清晰(
nam, addr, sal)→ 改用 name, address, salary
- ✅ 檔案名與類別名一致(
HelloWorld.cs)
4. 縮排與間距
- 使用 Tab 縮排,非空白鍵
- 註解與代碼對齊
- 遵循 VS 自動格式化,勿手動調整
- 邏輯區塊間空一行
- 類別內方法實作間空一行,大括號獨佔一行
- 運算符與括號前後各空一格:
if (showResult == true) { ... }
5. 良好程式習慣
- 單一檔案 ≤ 300-400 行,超過拆分類別
- 單一方法 1-30 行,超過拆分
- 方法名自述功能,免文件說明
- 單一職責:一個方法只做一件事
- 優先使用 C# 內建型別(
int, string, object),非 Framework 別名(Int16, String, Object)——利於跨語言移植
- 魔術數字改用常數,字串常數改用資源檔
- 減少成員變數,改用區域變數傳遞
- 避免方法間共享成員變數,改用 enum 表達離散值
- 成員變數私有化,透過 public/protected Property 存取
- 避免硬編碼路徑,使用相對路徑與可程式化路徑
- 啟動自檢:檢查檔案、資料庫連線,友善錯誤提示
- 設定檔遺失自動建立預設值;值錯誤拋出異常並提示正確值
6. 註解原則
- 非逐行註解,僅必要處註解
- 自述式代碼減少註解需求
- 複雜演算法必須詳盡文件與註解
- 拼字、語法、標點正確
二、資料庫設計規範
1. 資料表分類與命名
| 分類 | 前綴 | 說明 |
| 系統表 | TSYS_ | 支撐業務模型(流程、系統管理) |
| 業務表 | TBIZ_ | 產品通用功能模組 |
| 用戶表 | 自定義 | 避免與系統/業務表衝突 |
命名規則:以 T 開頭,實義單詞以底線分隔。
2. 欄位命名
- 參考代碼命名規範,避開保留字(
index, password, id 等)
- 核心系統表建議用
F1, F2...Fn 防剖析,避免 F0(部分 DB 不支援)
3. 索引策略
- 索引提升查詢、降低寫入效能,雙刃劍
- 查詢頻繁、資料量大的表必建索引
- 主鍵自動建索引,外鍵務必建索引
- ❌ 大欄位(BLOB/長文本)建索引 → 佔用空間大
- ❌ 小表且頻繁異動建索引
- ❌ Identity 欄位作主鍵關聯 → 影響資料遷移,建議程式產生唯一值
- 大表高併發讀寫衝突 → 垂直/水平拆分後再建索引
4. 預存程序與函數
❌ 避免使用特定資料庫專有語法/預存程序,降低可攜性。
✅ 建議:業務邏輯置於應用伺服器中間層物件。
5. 欄位型別定義
- ❌ 避免 BLOB,必用勿建索引、勿多欄位
- ❌ 避免日期型別,改用
CHAR(19) 格式 YYYY-MM-DD HH:MI:SS
- 固定長度字串用
CHAR(n),非 VARCHAR
- 數值型欄位用對應數值型別,勿存字串
三、COM 與 .NET 互操作規範
(內容截斷,原文未完整提供)
copyright ©
萬盛學電腦網 all rights reserved