SQL 命名規範與編碼風格指南

物件命名規範

SQL 編碼風格

SELECT 
    MB.BlogID,
    MB.Title,
    MB.CreateDate,
    MB.VisitTimes
FROM 
    dbo.Module_Blog AS MB
WHERE 
    MB.ModuleID = @ModuleID
ORDER BY 
    MB.BlogID DESC;

關鍵規則

• 關鍵字（SELECT、FROM、WHERE、ORDER BY）獨佔一行，大寫。
• 每個欄位獨佔一行，逗號前置（,MB.Title）便於註解與版本比對。
• 欄位前必須加上表別名（MB.）。
• 每個條件獨佔一行，邏輯運算子（AND/OR）行首對齊。
• 別名使用有意義縮寫，避免 a、b、t1。
• 縮排使用 4 空格，不使用 Tab。

其他建議

• 避免使用保留字作為物件/欄位名；若必須使用，加上方括號 [Order]。
• 布林欄位建議前綴 Is、Has、Can（如 IsActive）。
• 日期時間欄位建議後綴 At、On、Date（如 CreatedAt）。
• 外鍵欄位命名為 參考表名Id（如 CustomerId）。
• 統一使用 Unicode 型別（NVARCHAR、NCHAR）支援多語言。

結語

統一命名與編碼風格能大幅降低團隊溝通成本、提升程式碼可讀性與維護性，建議納入專案開發規範並配合 Code Review 執行。