Miscellaneous-CPPComments

Checks for correctly used comment style in C++ units

Required inputs: IR

This rule checks that comments starting with the invalid prefix are not used in C++ units.

This rule allows configuring the type of comment that is considered invalid.

See Also

Rule Miscellaneous-CComments

Possible Messages

Key	Text	Severity	Disabled
cpp_comment_style	Use of invalid comment style in C++ unit.	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

exception

exception : str | None = '/**'

Start of a valid comment, even if it has an invalid prefix.

 

invalid

invalid : str = '/*'

Start of an invalid comment.