跳轉到

D-20260706-08|註解鐵則翻案:自足、零文檔引用

背景與驅動力

原鐵則要求註解「引 spec 出處、不複述內容」。使用者批評三理由全數成立:spec 章節重編 = 引用必漂移(本 corpus 重編號之痛即鐵證);開源讀者被迫對照外部文檔、閱讀困難;不預設 specs 永遠公開。

考慮過的選項

  • 維持「引出處、不複述」:三理由證明成本高於價值——翻案。
  • 自足、零文檔引用(採納)。

決定

  • 註解自足、零文檔引用:註解不得出現 spec 檔名 / 章節;一句話講完語意 / 約束、單看程式碼可讀;深層設計理由單一權威 =specs、註解不複述。
  • 雙向對照鍵 = 名稱:常數 / 模組 / 介面名 spec 與 code 同名,spec 對 const 的 CI 按名對帳;spec 對 code 的對應由 spec 側維護(模組索引表)、code 側零反向指標。
  • 全 codebase 清掃 88 處落地(純指標行刪除、混語意行改寫自足、骨架 stub 重生成),程式碼面 .md 引用 0 殘留。

後果與影響

取代同日程式碼風格規範中的註解條款(該規範無獨立決策檔);規範宿主 = 程式架構.md。註解與 spec 的耦合面歸零後,章節重編號不再產生程式碼側漂移;名稱同一性成為唯一契約、由 CI 看守——與 D-20260604-01 的單一權威紀律同族。