stylecop 相关问题

StyleCop分析C#源代码以强制执行一组样式和一致性规则。

Stylecop 干扰 gitlab CI 中 docker 镜像中的 EfBundle 创建

我在我的项目中配置了 stylecop,当我运行时 运行 dotnet ef 迁移包 --project {CSPROJ_PATH}.csproj -r alpine.3.7-x64 --self-contained --configuration Bundle -o /build/migrationb...

回答 1 投票 0

针对内部接口禁用 StyleCop 的 SA1600 规则

StyleCop.Analyzers:1.1.118 我的 stylecop.json: { “$架构”: “https://raw.githubusercontent.com/DotNetAnalyzers/StyleCopAnalyzers/master/StyleCop.Analyzers/StyleCop.Anal...

回答 2 投票 0

如何使用 StyleCop 强制执行文件范围的命名空间

我想要这个 命名空间示例代码 { 公开课我的班级 { } } 成为这样 命名空间示例代码; 公开课我的班级 { } 在 StyleCop 的帮助下。 有没有标准或定制...

回答 1 投票 0

为什么 StyleCopAnalyzers 认为全局 using 应该在命名空间内声明,而这种语法是不可能的?

我正在创建一个 NUnit 测试项目,在创建该项目时,MS Visual Studio 创建了一个名为Usings.cs 的文件,其中包含以下行 全局使用 NUnit.Framework; 这告诉项目包括...

回答 2 投票 0

StyleCop SA1600规则和接口实现

StyleCop 规则 SA1600 要求每个类型成员都有自己的文档标头。我认为这是非常合理的,我喜欢这个规则。但假设我们有以下层次结构: /// StyleCop 规则 SA1600 要求每个类型成员都有自己的文档标头。我认为这是非常合理的,我喜欢这个规则。但假设我们有以下层次结构: /// <summary> /// Documentation for interface ISomeModule. /// </summary> interface ISomeModule { /// <summary> /// Documentation for DoA. /// </summary> void DoA(); /// <summary> /// Documentation for DoB. /// </summary> void DoB(); } /// <summary> /// Documentation for StandardModule. /// </summary> class StandardModule : ISomeModule { private readonly SomeCoolType _value; /// <summary> /// Documentation for constructor. /// </summary> public StandardModule(SomeCoolType value) { _value = value; } // SA1600 violation here! public void DoA() { // realisation of DoA(). } // SA1600 violation here! public void DoB() { // realisation of DoB(). } /// <summary> /// Documentation for MyOwnDoC. /// </summary> public void MyOwnDoC() { // realisation of MyOwnDoC(). } } 在这里,我完整记录了接口成员DoA()和DoB(),我们从接口文档中知道这些方法到底做了什么。 VS Intellisence 也知道这一点,即使在类 StandardModule 中,我们也可以通过将鼠标悬停在这些方法上来查看方法的描述。因此没有必要将文档从接口复制到派生类。但 StyleCop 要求这样做。为什么?有谁知道吗 如果我们尝试解决这个问题,我们可以采用 4 种不同的方法: 1。从界面复制文档。 这里的问题是,如果我们复制文档,如果接口行为发生变化,我们将遇到更新所有派生类中的文档的问题。 2。使用 SuppressMessageAttribute 抑制消息。 好吧,假设我们说“好吧,我可以使用 SuppressMessageAttribute”来抑制这种我不同意的违规行为。我在 StandardModule 类前面添加了规则 SA1600 的 SuppressMessageAttribute。但现在 StyleCop 完全停止检查 StandardModule 类中的文档标题。我不想要它,因为我们有构造函数和其他一些方法。 3.将班级划分为区域, 我们可以将StandardModule类分为2个区域,并仅在实现接口ISomeModule的部分使用消息抑制。我认为所有部分都应该放入一个文件中。我最喜欢这种方法(在方法 #4 之后),但现在我们必须处理一个类的多个部分。 4。修改规则 SA1600。 是否可以自己实现规则 SA1600,以便考虑类成员是否记录在基类中或接口中? (这里我不是问我们是否可以为StyleCop编写自己的规则,我知道我们可以,但我的意思是StyleCop引擎是否可以检查某些成员是否来自接口或基类)。 解决SA1600接口实现问题的最佳方法是什么? 即将推出的 StyleCop 4.4.1 版本应该支持继承文档标签。如果您愿意使用支持此标签的文档生成工具(例如:Sandcastle 或 FiXml),您可能会有一个可以解决您的问题的可行解决方案。 我从来没有想到这会是一个问题,因为我一直认为接口的声明的文档与该接口的实现的文档不同。 我可能错了,但我很高兴学习。 我对您问题的实际答案是:1)复制从界面翻译文档。 我只是使用 /// 来实现这一点。 当它只是接口中的方法时,我也倾向于在公共方法上使用它。像这样的单一方法往往具有与其接口完全相同的解释。 (该接口存在的唯一原因是为了该方法)。

回答 3 投票 0

忽略 Visual Studio Code 中的 StyleCop 规则

我在 Visual Studio Code 中进行开发,最近开始使用 StyleCop 来改进我的 C# 编码风格。 在我的 .csproj 文件中,我向 StyleCop.Analyzers 添加了 PackageReference,现在可以...

回答 1 投票 0

在 VS 2022 中使用 StyleCop 将自定义规则添加到 C# 项目

我似乎找不到一个好的教程来添加一些尚未在 StyleCop [StyleCop Package] (https://i.stack.imgur.com/RsFCI.png) 中自定义的自定义样式规则,例如创建一个...

回答 1 投票 0

如何使用 `dotnet format` 全局应用特定的 StyleCop 规则?

我已经在使用 C# 编写的项目上安装了 StyleCop.Analyzers。规则严重性设置为建议。 如何使用 dotnet 格式对整个项目应用特定规则? 我试过了

回答 1 投票 0

“ CS8700:多个分析器配置文件不能位于同一目录中,而只能包含一个StyleCop文件

我正在尝试学习在个人项目上使用StyleCop。它不是很大,解决方案的结构如下:-MySolution(2个项目中的2个)-解决方案项-.editorconfig ...

回答 1 投票 0

未从nuget包更新代码分析规则集

我正在尝试使用nuget包中的自定义规则集文件。我将给定的.props添加到了程序包的构建文件夹中:

回答 1 投票 0

StyleCop.Analyzers Nuget依赖项

我已经在私有Azure Artifacts环境上创建了一个Nuget程序包,该程序包包含StyleCop.Analyzers的自定义配置,以便可以集中编码标准的配置。 ...

回答 1 投票 0

我如何隐藏StyleCop警告SA1403?

考虑此代码,该代码包含在一个文件中:命名空间Foo {公共局部类一个{}}命名空间Baa {公共局部类两个{}}编译此...

回答 4 投票 9

如何使用Stylecop Analyzer和自定义规则集创建nuget包?

我需要使用stylecop.json和something.ruleset创建一个nuget包,并引用stylecop分析器。该软件包将在所有团队中使用,以标准化....

回答 1 投票 0

Stylecop隐藏规则

我需要跳过使用某种stylecop的规则。我曾尝试放置类,名称空间;无济于事。相同主题的文档(存档链接)在正确位置放置此主题的任何想法...

回答 1 投票 1

样式处理隐藏规则

我需要跳过使用某种stylecop的规则。我曾尝试使用命名空间类,但使用不成功以下是同一文档:http://www.stylecop.com/docs/SA1210.html ...

回答 1 投票 1

哪个设置告诉Resharper(使用StyleCop)不在一行上对齐ASP.Net控制器属性?

示例代码(请不要编辑此代码,应使用格式):[AllowAnonymous] [HttpPost(“ Register”)]公共异步任务 Register(RegisterParameters参数)...]]]

回答 2 投票 0

我如何在Roslyn中使用StyleCop

我正在像这样使用Roslyn构建我的C#代码:var solution = space.OpenSolutionAsync(projectPath).Result; var project = solution.GetProject(solution.ProjectIds [0]); var编译...

回答 1 投票 0

将StyleCop签入策略与StyleCop +一起使用

我有一个StyleCop和StyleCop +,它们通过StyleCop.MSBuild集成到项目中。项目构建后,与StyleCop +相关的所有警告均会正确显示。我需要将规则与...

回答 1 投票 1

CA1500 vs. SA1309-哪一个获胜?

我的意思是,我了解代码分析和StyleCop都是作为指导原则的,许多人还是选择忽略这些。话虽如此,我想看看...

回答 6 投票 19

当将对象放置在依赖注入容器中时,如何处理CA2000(处理IDisposable对象)?

根据Microsoft,对于HttpClient的最佳实践是维护HttpClient的单例版本(解释一下,但这是结果,请不要立即处置它)。我自己的测试...

回答 1 投票 1

© www.soinside.com 2019 - 2024. All rights reserved.