文档规则
文档规则支持通过正确为外部可见的 API 使用 XML 文档注释来编写记录详尽的库。
在本节中
规则 | 描述 |
---|---|
CA1200:不要使用带前缀的 cref 标记 | XML 文档标记中的 cref 属性是指“代码引用”。 它指定标记的内部文本是一个代码元素,例如类型、方法或属性。 避免使用带有前缀的 cref 标记,因为它会阻止编译器验证引用。 它还会阻止 Visual Studio 集成开发环境 (IDE) 在重构过程中查找和更新这些符号引用。 |
文档规则支持通过正确为外部可见的 API 使用 XML 文档注释来编写记录详尽的库。
规则 | 描述 |
---|---|
CA1200:不要使用带前缀的 cref 标记 | XML 文档标记中的 cref 属性是指“代码引用”。 它指定标记的内部文本是一个代码元素,例如类型、方法或属性。 避免使用带有前缀的 cref 标记,因为它会阻止编译器验证引用。 它还会阻止 Visual Studio 集成开发环境 (IDE) 在重构过程中查找和更新这些符号引用。 |