XmlCommentChecker 1.1.1

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet tool install --global XmlCommentChecker --version 1.1.1
This package contains a .NET tool you can call from the shell/command line. 
dotnet new tool-manifest
                    


                            if you are setting up this repo
                        

                    

                
dotnet tool install --local XmlCommentChecker --version 1.1.1
This package contains a .NET tool you can call from the shell/command line. 
#tool dotnet:?package=XmlCommentChecker&version=1.1.1
                    


                    

                
nuke :add-package XmlCommentChecker --version 1.1.1

XML Comment Checker

A simple tool to check for missing XML comments in C# files. This tool supports both scanning a folder containing multiple C# files and checking an individual file. It reports the methods that are missing XML comments.

Features

  • Scan entire folders or individual files.
  • Detect missing XML documentation comments in methods.
  • Supports both folders and individual file inputs.
  • Clean and easy-to-read results printed to the console.

Installation

You can install the XmlCommentChecker as a NuGet package in your project.

Usage

1️⃣ Run for a Folder

Scan all .cs files in a folder for missing XML comments:

XmlCommentChecker --folder "FolderPath"

2️⃣ Run for a Single File

Check an individual .cs file for missing XML comments:

XmlCommentChecker --file "FolderPath\FilePath.cs"

3️⃣ Run for Both Folder and File

Scan a folder and check a specific file at the same time:

XmlCommentChecker --folder "FolderPath" --file "FolderPath\FilePath.cs"
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

Version Downloads Last Updated
1.1.2 205 2/18/2025
1.1.1 164 2/1/2025
1.1.0 165 1/31/2025