Metric-Comment.Preceding

Preceding Comments

Required inputs: RFG

Counts the number of comments directly before the routine header that do not share a line with another non-comment code construct.

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: CommentMetrics, Analysis-GlobalOptions

display_name

display_name : str | None = 'Preceding Comments'

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

 

max_value

max_value : int | None = None

Maximum allowed value. None if unlimited.

 

min_value

min_value : int | None = 1

Minimum allowed value. None if unlimited.

 

rfg_metric_name

rfg_metric_name : str = 'Metric.Comment.Preceding'

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