This repository contains an implementation of .NET documentation rules using the .NET Compiler Platform. Where possible, code fixes are also provided to simplify the process of correcting violations.
The preferable way to use the analyzers is to add the nuget package DotNetAnalyzers.DocumentationAnalyzers to the project where you want to enforce documentation rules.
The severity of individual rules may be configured using rule set files in Visual Studio 2015 or newer. For Visual Studio 2019 version 16.3 and newer, the severity of individual rules may be configured using .editorconfig.
For documentation and reasoning on the rules themselves, see the DOCUMENTATION.md.
DocumentationAnalyzers can be installed using the NuGet command line or the NuGet Package Manager in Visual Studio 2015.
Install using the command line:
Install-Package DotNetAnalyzers.DocumentationAnalyzers⚠ Prereleases of the DotNetAnalyzers.DocumentationAnalyzers package use Semantic Versioning 2, which requires NuGet 4.3.0 (Visual Studio 2017 version 15.3) or newer. Users with clients that do not support Semantic Versioning 2 may install prereleases using the DotNetAnalyzers.DocumentationAnalyzers.Unstable package instead.
If you use older versions of Visual Studio in addition to Visual Studio 2015 or Visual Studio 2017, you may still install these analyzers. They will be automatically disabled when you open the project back up in Visual Studio 2013 or earlier.
See CONTRIBUTING.md
An up-to-date list of which documentation rules are implemented and which have code fixes can be found here.