StyleCop setup and rules

StyleCop analyzes your C# code for consistent style and formatting. It helps teams keep the same naming, spacing, and documentation rules across your projects. It's a small thing that pays off in code readability and maintainability.

You can add StyleCop support to your project by installing a NuGet package:

Install-Package StyleCop.Analyzers

This integrates StyleCop directly with Visual Studio's code analysis. Warnings show up in the Error List as you type.

You can customize the rules by adding a stylecop.json file to your project root. This allows configuring options, similar to this:

{
  "settings": {
    "documentationRules": {
      "companyName": "Contoso Ltd.",
      "copyrightText": "Copyright (c) 2018 Contoso Ltd."
    },
    "layoutRules": {
      "newlineAtEndOfFile": "require"
    }
  }
}

If you want to enable or disable specific rules, create an .editorconfig file and add entries like:

dotnet_diagnostic.SA1600.severity = none
dotnet_diagnostic.SA1309.severity = warning

This way, you can apply the same standards automatically in CI builds using dotnet build. No manual checks needed, just clean and consistent code.