An open API service indexing awesome lists of open source software.

https://github.com/ulrichb/xmldocinspections

Configurable XML Doc warnings for ReSharper
https://github.com/ulrichb/xmldocinspections

c-sharp doc-comments resharper resharper-plugin static-analysis xml-doc

Last synced: 2 months ago
JSON representation

Configurable XML Doc warnings for ReSharper

Awesome Lists containing this project

README

        

# XML Doc Inspections ReSharper Extension

[![Build status](https://github.com/ulrichb/XmlDocInspections/actions/workflows/build.yml/badge.svg)](https://github.com/ulrichb/XmlDocInspections/actions/workflows/build.yml)
[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/ulrichb/XmlDocInspections?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
Line Coverage
Branch Coverage

Plugin pages: [ReSharper](https://plugins.jetbrains.com/plugin/11648-xml-doc-inspections) / [Rider](https://plugins.jetbrains.com/plugin/10151-xml-doc-inspections)

[History of changes](History.md)

## Description

A simple ReSharper extension which enables to show warnings for missing XML Doc comments for types and type members. In contrast to the C# compiler's [CS1591 warning](https://msdn.microsoft.com/en-us/library/zk18c1w9.aspx) which emits a warning for all public or protected types and members, this extension provides configuration options. Further it comes with a [quick fix](#quick-fix) action to generate doc comment templates.

### ReSharper options page

Options Page

### Quick Fix

QuickFix