DotNetAnalyzers / DocumentationAnalyzers

Analyzers for XML documentation
MIT License
35 stars 6 forks source link

Place text in paragraphs #19

Closed sharwell closed 6 years ago

sharwell commented 6 years ago

Migrated from DotNetAnalyzers/StyleCopAnalyzers#601

I would like to propose the implementation and inclusion of a new StyleCop diagnostic.

Category: Documentation Rule: Place text in paragraphs Description: Text within certain documentation elements should be placed within <para> tags. This includes all blocks of text within a <remarks> or <note> element.

Rationale: This rule ensures these elements appear consistently when rendered to a variety of output media, including HTML.