AutosarC++18_10-A2.7.5ΒΆ

Comments shall not document any actions or sources (e.g. tables, figures, paragraphs, etc.) that are outside of the file

Required inputs: IR

Rationale

Commenting only actions and sources that are inside a particular file reduce dependencies among files. Comments in a file will require changes only when content of the file reworked.

Note: This rule does not affect valid assumptions or preconditions for entities within the file.

See Also
  • JSF December 2005 [8]: AV Rule 128: Comments that document actions or sources (e.g. tables, figures, paragraphs, etc.) outside of the file being documented will not be allowed.

Possible Messages

Key

Text

Severity

Disabled

dummy

This is not a real rule; it is only used as a dummy object when retrieving the config of the base class

None

False

Options