6.2.4.2. CodeAnnotations

Markup comments to influence analysis

Nested Rules

ExternalCodeAnnotations

Code annotations provided outside the source code

LegacyFormats

Code annotations to support migration from other tools

NonSuppressingIssueComments

Code annotations that do not suppress issues (e.g., only adding a justification)

ReportSuppressedCodeRanges

Report code ranges that are affected by code annotations

ReportUnclosedRestOfFileComments

Report Axivion Disable comments as style violations if they are not re-enabled at the end of the file

ReportUnusedComments

Report superfluous control comments as style violations

Suppressions

Code annotations that suppress issues

Options

  • Setting an option for this rule means setting the default for all nested rules.

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

show_debug_output

show_debug_output : bool = False

If true, the system prints several diagnostic hints that can help to investigate why a comment did not have the expected effect. Should not be used in a regular CI run, only for manual debugging.
 

use_analysis_config_py

use_analysis_config_py : bool = False

Deprecated. If true, configuration for code annotations as used before axivion 7.0 is read in (analysis_config.py).

If you mix old and new configuration, the order is as follows:

  1. old defaults,
  2. new-style configured settings,
  3. settings from custom analysis_config.py files (that is, new configuration overwrites old defaults, but if you were using an analysis_config.py file, that will win)