【问题标题】:How to make an exception to certain StyleCop rules? [duplicate]如何对某些 StyleCop 规则进行例外处理? [复制]
【发布时间】:2011-09-28 20:08:12
【问题描述】:

可能重复:
How to suppress a StyleCop warning?

目前我正在为我们的项目设置 StyleCop,我偶然发现了 StyleCop 的一条规则。关于 SA1300 命名规则:

SA1300:命名空间名称以 大写字母:iCompanyName。

所以我的公司以小写字母开头。各种产品名称也可以。因此,是否可以在 Settings.StyleCop 文件中为此规则添加例外?

我想阻止使用 C# 编写自定义 StyleCop 规则。

提前感谢您的回复。

编辑: 我意识到我应该注意到我实际上并不想完全禁用/抑制 StyleCop 规则。我只想对这个命名规则做一些例外。

【问题讨论】:

  • my company starts with a lower-case letter 最简单的选择是切换到一家名称符合 style-cop 的公司。

标签: c# .net visual-studio-2010 stylecop


【解决方案1】:

SA1300 规则不可配置(至少在 4.4 版中)。如果您不喜欢它的行为并且不想完全禁用该规则,则需要使用替代自定义规则。您也许可以从第三方(例如 StyleCop+ 项目)中找到可用的工具。如果没有,你几乎只能自己动手了......

【讨论】:

  • 好建议尝试 StyleCop+ 项目。但是,它并没有真正提供使命名规则例外的功能。我想我必须制定自己的规则,认为在配置中应该是可能的。
  • 如果您希望规则可配置,您可以在stylecop.codeplex.com/workitem/list/basic 添加功能请求。就个人而言(尤其是作为 API 使用者),我认为不应允许命名空间大小写偏离此规则,但是 ymmv...
  • 嗨,蒙蒂。我是 StyleCop+ 的作者,根据它的设计,它提供了极其灵活的命名规则。不同的命名风格、前缀、例外、缩写、复杂的单词……这就是 StyleCop+ 的全部目的。例如,在您的情况下,您可以强制将所有命名空间命名为 [PascalCase] 或“iYourCompany”(如例外)。或者,例如,[PascalCase] OR i[PascalCase](即允许任何以“i”开头的名称)。我可以同意的是,它可能缺少文档——但它正在处理中。请随时与我联系,我会很乐意回答任何问题。谢谢!
  • @Oleg,感谢您的精彩回答。我确实又给了它一次机会,我设法让它按照我想要的方式工作!!非常感谢。
  • 真的不可配置吗?警告代表“删除前缀或将其添加到允许的前缀列表中。”。或者警告是错误的,或者应该有一个可以添加前缀的列表。 在哪里?我在任何地方都找不到。
【解决方案2】:

您可以根据 StyleCop 网站 - http://stylecop.codeplex.com/wikipage?title=Rule%20Suppressions 上的说明逐个屏蔽消息

另外,看看这个问题 - How to suppress a StyleCop warning?

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 2021-05-15
    • 1970-01-01
    • 1970-01-01
    • 2017-04-15
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多