DocumentationAnalyzers

KO | EN

gitlite — search

#javascript #react #typescript #machine-learning #linux #docker #macos #java #awesome #cli #awesome-list #ios #mcp #open-source

DocumentationAnalyzers

(★ 41)

Analyzers for XML documentation

DocumentationAnalyzers Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Documentation Analyzers for the .NET Compiler Platform

[![NuGet](https://img.shields.io/nuget/v/DotNetAnalyzers.DocumentationAnalyzers.svg)](https://www.nuget.org/packages/DotNetAnalyzers.DocumentationAnalyzers) [![NuGet Beta](https://img.shields.io/nuget/vpre/DotNetAnalyzers.DocumentationAnalyzers.svg)](https://www.nuget.org/packages/DotNetAnalyzers.DocumentationAnalyzers)

[![Join the chat at https://gitter.im/DotNetAnalyzers/DocumentationAnalyzers](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/DotNetAnalyzers/DocumentationAnalyzers?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[![Build status](https://ci.appveyor.com/api/projects/status/8jw2lq431kgg44jl/branch/master?svg=true)](https://ci.appveyor.com/project/sharwell/Documentationanalyzers/branch/master)

[![codecov.io](http://codecov.io/github/DotNetAnalyzers/DocumentationAnalyzers/coverage.svg?branch=master)](http://codecov.io/github/DotNetAnalyzers/DocumentationAnalyzers?branch=master)

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.

## Using DocumentationAnalyzers

The preferable way to use the analyzers is to add the nuget package [DotNetAnalyzers.DocumentationAnalyzers](http://www.nuget.org/packages/DotNetAnalyzers.DocumentationAnalyzers/)
to the project where you want to enforce documentation rules.

The severity of individual rules may be configured using [rule set files](https://docs.microsoft.com/en-us/visualstudio/code-quality/using-rule-sets-to-group-code-analysis-rules)
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](DOCUMENTATION.md).

## Installation

DocumentationAnalyzers can be installed using the NuGet command line or the NuGet Package Manager in Visual Studio 2015.

**Install using the command line:**

```ps
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.

## Team Considerations

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.

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md)

## Current status

An up-to-date list of which documentation rules are implemented and which have code fixes can be found [here](https://dotnetanalyzers.github.io/DocumentationAnalyzers/).

DocumentationAnalyzers

DocumentationAnalyzers Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

DocumentationAnalyzers

DocumentationAnalyzers Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README