Skip to content

alvinward/Dwaas.Param.Documentation.Analyzer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Build status

Dwaas.Param.Documentation.Analyzer

Uses a dictionary of names and descriptions to verify and correct C# <param> comment documentation tags.

Installation

The Param Analyzer is available as a NuGet package. You can install it using the NuGet Package Console window:

PM> Install-Package Dwaas.Param.Documentation.Analyzer

Or download and install the Visual Studio Extension.

Configuration

Add a file named Dwaas.Param.Documentation.Analyzer.json to the project (if it has not been added automatically) and set it's BuildAction to AdditionalFiles in the properties window.

The file should contain a list of the parameter or property names and their descriptions, for example:

{
  "Example1": "A description for the param 'Example1'.",
  "Example2": "A description for the param 'Example2'."
}

About

Uses a dictionary of names and descriptions to verify and correct C# <param> comment documentation tags.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published