C#-CSharpCommentsConvention¶

Checks for correctly used comment style in C# files

Required inputs: CSharpAST

This rule reports the use of delimited comments (starting with with /* and ending with */) in C# source code.

Possible Messages

Key	Text	Severity	Disabled
csharp_comment_style	Use of invalid comment style in C# source file.	None	False

Options¶

This rule shares the following common options: excludes, includes, justification_checker, post_processing, provider, severity
The following places define options that affect this rule: Stylechecks, Analysis-GlobalOptions

exception : str = '/**'

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

invalid : str = '/*'

Start of an invalid comment.

skip_file_header_comment : bool = True

Ignore comments at the very beginning of a file.