CsNoInBodyCommentCheck class

codespecs_derivation_contract.md §6 check 26.

codespecs_derivation_contract.md §2.8 C6 gives the in-body comment position a value, and the value is nothing. It is the one C-rule that forbids rather than requires, and it exists because an in-body comment is where a generator starts explaining itself — "// TODO: implement", "// step 2 of 3", "// derived from CLA-4.2". Every one of those is either already in the doc comment (C2) or is generator commentary that no SOM section said, which C1 forbids as a source.

codespecs_derivation_contract.md §2.7's three-line banner is the sole // an emitted file may hold, so the check counts it out rather than filtering all banner-position comments away: a fourth // above the imports is a comment that has crept in beside the banner, and is exactly as forbidden as one inside a body.

Inheritance

Constructors

CsNoInBodyCommentCheck()
Creates the check.
const

Properties

definedIn → String
The section that defines the rule, in the same two forms CodeSpecsViolation.definedIn takes.
no setteroverride
hashCode → int
The hash code for this object.
no setterinherited
number → int
The codespecs_derivation_contract.md §6 row number.
no setteroverride
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
title → String
The rule, in one line — the codespecs_derivation_contract.md §6 row text.
no setteroverride

Methods

fail(String message, [CsLocation? at, String? token, String? area]) → CodeSpecsViolation
Builds a violation attributed to this check.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
run(CodeSpecsValidationInput input) → List<CodeSpecsViolation>
Runs the check, returning one violation per breach.
override
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited