文件規則
文件規則支援透過正確使用 XML 文件註解來撰寫妥善記載的程式庫,以供外部可見的 API 使用。
本節內容
規則 | Description |
---|---|
CA1200:請避免使用具有前置詞的 cref 標記 | cref 屬性在 XML 文件標記中表示「程式碼參考」。 它會指定標記的內部文字是程式碼項目,例如類型、方法或屬性。 避免搭配前置詞使用 cref 標籤,因為它會讓編譯器無法驗證參考。 它也會讓 Visual Studio 整合式開發環境 (IDE) 無法在重構期間尋找及更新這些符號參考。 |