Miscellaneous-MarkupComments

Scans for comments containing a specified regular expression

Required inputs: IR

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

• This rule shares the following common options: exclude_in_macros, exclude_messages_in_system_headers, excludes, extend_exclude_to_macro_invocations, includes, justification_checker, languages, post_processing, provider, report_at, severity

• The following places define options that affect this rule: Stylechecks, Analysis-GlobalOptions

files_to_check

files_to_check : bauhaus.rules.axivion.lexical.comments.FileToCheckSet = {'Primary_File'}

Files to be checked, e.g. Primary_File or File.

 

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.