目錄 / Table of Contents

程式碼與 XML 文件風格

修改手寫 C# 或 XML 文件時適用本指南。先融入周遭程式碼的命名、註解密度與慣用語法, 再遵守下列 OdfKit 特有要求。

C# 程式碼

  • 使用目標 SDK 支援的現代 C# 語法;適合時使用集合運算式、主要建構函式、目標類型 new() 與模式比對。
  • 手寫 C# 使用檔案範圍命名空間。
  • 專案已啟用可空性;新增程式碼必須維持 Null 安全。
  • private/internal 成員與一般行內註解使用正體中文臺灣地區用語,不需為了說明明顯 程式碼而增加註解。

XML 文件

  • 手寫 public/protected API 必須具有完整的英文+正體中文 XML 文件,不得以 #pragma warning disable 1591 規避。
  • <summary><remarks> 等多行區塊中,英文描述獨立一行在前,正體中文獨立一行 在後;英文句使用半形句號,中文句使用全形句號。
  • <summary></summary> 各自獨佔一行。此規則也適用於 internal/private 成員 的純中文 XML 摘要。
  • <param><returns><exception><typeparam> 的英文及中文說明置於同一行, 以 / 分隔。
  • 修改既有僅含中文的公開 API 文件時補上英文摘要;不因單一修改擴大為全專案回填。
  • 中文與相鄰的半形英文、數字或符號之間加入一個半形空格,並移除重複標點、不對稱 括號與多餘句點。

完成後執行:

pwsh eng/Format-Safe.ps1

此入口會執行安全格式化、合併衝突檢查、一行式 <summary> 與雙語 XML 文件閘門。