C#-EntityMarker

Reports a (suppressed) issue per entity of a configurable type

Required inputs: CSharpAST

This rule generates one issue per entity under analysis and immediately suppresses the issue. Relevant entities can be selected with a set of C# syntax node types. The rule is useful for checking completeness of the analysis. Note that you have to import the suppressed issues (see /Results/Dashboard/import_suppressed_issues) into the database.

Possible Messages

Key

Text

Severity

Disabled

included_entity

{0} is checked.

None

False

Options

entity_type

entity_type : set[bauhaus.rules.csharp.CSharpSyntaxNodeType] = set()

Types of entities to report. Any C# syntax node name is possible.
 

use_baseclass_name_in_message

use_baseclass_name_in_message : bool = True

If set to True, includes the exact name of the type configured as entity_type in any issue message. Otherwise uses the actual type of the C# syntax node, which may be derived from the types configured as entity_type and may be very specific technical descriptions of the entity.