C#-MarkupComments

Scans for comments containing a specified regular expression

Required inputs: CSharpAST

The rule usually helps to find certain keywords, like TODO, in comments.

Possible Messages

Key

Text

Severity

Disabled

markup_message

Markup comment needs review.

None

False

Options

markup_text_regex

markup_text_regex : bauhaus.analysis.config.SearchPattern = 'TODO|FIXME|HACK|CHECK|XXX|DEBUG'

This rule reports comments where this Python regular expression finds a match in the comment text.