文件規則
文件化規則支援透過對外部可見 API 正確使用 XML 文件批註,來撰寫文件完善的程式庫。
在本節中
規則 | 描述 |
---|---|
CA1200:避免使用具有前綴的 cref 標籤 | XML 文件標籤中的 cref 屬性表示「程式碼參考」。 指定標記的內部文字為程式碼元素,例如類型、方法或屬性。 請避免使用具有前置詞的 cref 標記,因為它會防止編譯程式驗證參考。 它也可防止 Visual Studio 集成開發環境 (IDE) 在重構期間尋找和更新這些符號參考。 |
文件化規則支援透過對外部可見 API 正確使用 XML 文件批註,來撰寫文件完善的程式庫。
規則 | 描述 |
---|---|
CA1200:避免使用具有前綴的 cref 標籤 | XML 文件標籤中的 cref 屬性表示「程式碼參考」。 指定標記的內部文字為程式碼元素,例如類型、方法或屬性。 請避免使用具有前置詞的 cref 標記,因為它會防止編譯程式驗證參考。 它也可防止 Visual Studio 集成開發環境 (IDE) 在重構期間尋找和更新這些符號參考。 |