Metric-Lines.Class.Comment

Lines in Class containing Comments

Required inputs: RFG

Counts the lines of the type containing a source code token, starting at the type specifier and ending at the line where the closing curly brace is located. It applies to classes, interfaces, structs as well as their template counterparts. Same as Metric-Lines.Comment, but only applies to types.

Possible Messages

This rule has no predefined messages.

Options

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

• This rule shares the following common metric options: base_view_name, excluded_node_types, hierarchy_edge_name, hierarchy_view_name, propagate, report_all_values, report_propagated_values

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

display_name

display_name : str | None = 'Lines in Class containing Comments'

Description of the metric shown in the dashboard. If None, rfg_metric_name is used.

 

max_value

max_value : int | None = 600

Maximum allowed value. None if unlimited.

 

min_value

min_value : int | None = 0

Minimum allowed value. None if unlimited.

 

rfg_metric_name

rfg_metric_name : str = 'Metric.Lines.Class.Comment'

Name of the node attribute storing the metric value in the RFG.