CommentSense 1.0.0 

dotnet add package CommentSense --version 1.0.0
                    


                    

                
NuGet\Install-Package CommentSense -Version 1.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="CommentSense" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="CommentSense" Version="1.0.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="CommentSense" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add CommentSense --version 1.0.0
                    


                    

                
#r "nuget: CommentSense, 1.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package CommentSense@1.0.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=CommentSense&version=1.0.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=CommentSense&version=1.0.0
                    


                            Install as a Cake Tool

CommentSense

CommentSense is a Roslyn analyzer for C# that helps keep XML documentation complete, consistent, and useful.

CommentSense in Action

The project is provided as a NuGet package that is published on nuget.org, and it can be installed by running:

dotnet add package CommentSense

Requirements

CommentSense requires compiler XML documentation parsing:

<PropertyGroup>
  <GenerateDocumentationFile>true</GenerateDocumentationFile>
</PropertyGroup>

If this is disabled, CommentSense reports CSENSE000.

Quick start

Add a baseline .editorconfig:

[*.cs]
comment_sense.visibility_level = protected
comment_sense.require_capitalization = true
comment_sense.require_ending_punctuation = true

View docs/getting-started.md for more information.

Common Rules

CommentSense includes over 25 diagnostics, commonly used rules include:

Rule Purpose
CSENSE001 Missing symbol documentation
CSENSE002 / CSENSE004 Missing parameter / type parameter docs
CSENSE006 Missing return documentation
CSENSE012 Missing exception documentation
CSENSE016 Low-quality documentation
CSENSE018 Missing explicit inheritdoc (when required)

Documentation

Detailed documentation:

Contributions

Contributions are welcome! Read the contributing guide to get started.

License

This project is licensed under the MIT License.

There are no supported framework assets in this package.

Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.0 147 3/17/2026
1.0.0-rc.1 38 3/17/2026
0.3.0 248 2/6/2026
0.3.0-rc.2 63 2/6/2026
0.3.0-rc.1 66 2/5/2026
0.2.0 131 2/1/2026
0.2.0-rc.2 52 2/1/2026
0.2.0-rc.1 56 1/31/2026
0.1.0 103 1/30/2026
0.1.0-rc.3 52 1/30/2026
0.1.0-rc.2 52 1/28/2026