Metric-Lines.Routine.Comment

Lines in Routine containing Comments

Required inputs: RFG

Counts the lines of the routine containing a comment, starting at the signature and ending at the line where the closing curly brace is located. Same as Metric-Lines.Comment, but only applies to routines.

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 Routine containing Comments'

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

 

max_value

max_value : int | None = 100

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.Routine.Comment'

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