Comment.Todo.Analyzer 1.0.1

There is a newer version of this package available.
See the version list below for details. 
dotnet add package Comment.Todo.Analyzer --version 1.0.1                

                    
                

            
NuGet\Install-Package Comment.Todo.Analyzer -Version 1.0.1
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="Comment.Todo.Analyzer" Version="1.0.1">
  <PrivateAssets>all</PrivateAssets>
  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Comment.Todo.Analyzer --version 1.0.1                

                    
                

            
#r "nuget: Comment.Todo.Analyzer, 1.0.1"
#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. 
// Install Comment.Todo.Analyzer as a Cake Addin
#addin nuget:?package=Comment.Todo.Analyzer&version=1.0.1

// Install Comment.Todo.Analyzer as a Cake Tool
#tool nuget:?package=Comment.Todo.Analyzer&version=1.0.1

Comment.Todo.Analyzer

.NET analyzer for C# making sure that all TODO comments respect the same coding standards.

Options

These option can be setup inside the .editorconfig:

  • todo_analyzer.comment.format
    • Description: The format of the comment containing the TODO.
    • Accepted values: github, jira, custom
    • Default: github
    • Example: todo_analyzer.comment.format = github
  • todo_analyzer.comment.format.custom.token_regex
    • Description: The token used to identify if the comment is a TODO when todo_analyzer.comment.format is custom.
    • Default: \bTODO\b
    • Example: todo_analyzer.comment.format.custom.token = やるべきこと
    • Note: This is a regular expression.
  • todo_analyzer.comment.format.custom.regex
    • Description: The regular expression used to check if the comment match the expected criteria when todo_analyzer.comment.format is custom.
    • Default: ^ TODO .*$
    • Example: todo_analyzer.comment.format.custom.regex = ^ TODO \[MY-PROJECT\] [\d+] .+\.$

Default formats

  • github (Default) : ^ TODO \[\#[0-9]+\] .*\.$
    • Example: TODO [#33] This needs to be handled.
  • jira: ^ TODO \[[a-zA-Z0-9]+\-[0-9]+\] .*\.$
    • Example: TODO [COMMON-1234] This needs to be handled.

Rules

Rule ID Category Severity Url
TA0001 Documentation Warning TA0001
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.2 262 7/30/2023
1.0.1 155 7/30/2023

Enable coding standards on TODO comment using GitHub, Jira or custom formats.