Note types

Overview

Objecteering notes are used to complete the UML model with texts expressed in C# syntax. Usually, the internal processing of a UML method is entered in C# in a "CsCode" type note associated to a method's implementation.

Note: Certain notes can be added to certain model elements directly through the "C#" tab of the auxiliary window. For more information, please see "The auxiliary window and C# Developer".

Notes on a class

The ... type of note	is used to ...
CsHeaderText	insert text before declaring the class.
CsMemberText	insert text in the class body.
CsBottomText	insert text after declaring the class.
CsSummary & CsRemarks	add a comment to be used by the documentation tool.
CsAttribute	add a C# attribute declaration zone.
CsBeforeNamespaceText	insert text before the namespace.
CsInNamespaceText	insert text in the namespace (at the beginning).

Notes on an operation

The ... type of note	is used to ...
CsSummary & CsRemarks	add a comment which will be used by the documentation tool.
CsCode	provide C# code to implement the operation.
CsConstructorCall	insert C# code before the pre-condition (especially for calling the parent class’ constructor).
CsReturned	insert C# code after the post-condition (especially for instructing the method return).
CsAttribute	declare "C# attributes".

Notes on an attribute

The ... type of note	is used to ...
CsSummary & CsRemarks	add a comment which will be used by the documentation tool.
CsAttribute	declare "C# attributes".
CsSetCode	replace the code of the accessor in read only.
CsGetCode	replace the code of the accessor in read write.

Notes on a navigable association

The ... type of note	is used to ...
CsSummary & CsRemarks	add a comment which will be used by the documentation tool.
CsInitialValue	set initialization for the association
CsAttribute	declare "C# attributes".
CsSetCode	replace the code of the accessor in read only.
CsGetCode	replace the code of the accessor in read write.