Other ELKS items (not associated with a specific class)
On this site:
Offsite:
-
Alain Le Guennec's discussion and examples about deep_equal.
Style Guidelines for the specification of ELKS classes
Tag names
Postcondition tag names should not start with "result_". Consider starting
such tag names with the feature name instead. Rationale: The feature
name yields a more meaningful tag if an argumentless feature gets redefined
as an attribute and its postcondition moves to the class invariant. Exception:
This guideline seems to be impractical for infix operator features, and
has not been used for STRING infix "+".
Precondition tests for non-void arguments should have a tag comprising
the feature name followed by "_not_void" (instead of "_exists"). Rationale:
this is more specific.
Where the result of a query is completely defined by a single assertion,
that assertion should have the tag "definition".
Feature header comments
For boolean-valued queries: The header comment should be a question, and
should end with a question mark.
For other queries: The header comment should be a phrase, and should
not end with a question mark.
For commands: The header comment should be an abbreviated imperative
sentence, and should end with a full stop ("period").
Rationale: Follows the convention described on p888 of OOSC2.
Previous Work
The following documents describe work done before 6 October 1999: