c# - StyleCop XML 文档标题 - 使用 3 /// 而不是 2 //

Question

我在我的 c# 文件上使用 XML 文档标题来传递 StyleCop 规则 SA1633。

目前，我必须使用 2 斜杠注释规则来允许 StyleCop 识别标题。例如：

// <copyright file="abc.ascx.cs" company="MyCompany.com">
//     MyCompany.com. All rights reserved.
// </copyright>
// <author>Me</author>

这适用于 StyleCop，但是我想使用 3 斜杠注释规则使 Visual Studio 能够将注释理解为 XML 并提供 XML 功能（突出显示、自动缩进等）

/// <copyright file="abc.ascx.cs" company="MyCompany.com">
///     MyCompany.com. All rights reserved.
/// </copyright>
/// <author>Me</author>

问题是当使用 3 个斜杠时，StyleCop 不再看到标题并引发 SA1633 警告。

无论如何配置 stylecop 以使用 3 个斜杠了解标头包含在 XML 中？

score 12 · Accepted Answer

您可以建立一个自定义规则并禁用原始规则以支持您的新规则： http ://scottwhite.blogspot.com/2008/11/creating-custom-stylecop-rules-in-c.html

1 回答 1