Note types for C#

Overview

Modelio 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: Notes can be added to model elements directly through the "MDA Annotations" view.

Notes on an attribute

The list of types of note:

C# Summary: add a comment to be used by the documentation tool.
C# Remarks: add a comment to be used by the documentation tool.
C# Attribute: add a C# attribute declaration zone.
C# Setter Code: replace the code of the write accessor.
C# Getter Code: replace the code of the read accessor.

Notes on a class

The list of types of note:

C# Header Text: insert text before declaring the class.
C# Member Text: insert text in the class body.
C# Bottom Text: insert text after declaring the class.
C# Summary: add a comment to be used by the documentation tool.
C# Remarks: add a comment to be used by the documentation tool.
C# Attribute: add a C# attribute declaration zone.
C# Before Namespace Text: insert text before the namespace.
C# In Namespace Text: insert text after namespace opening.

Notes on an event

The list of types of note:

C# Add Code: insert code for the add method.
C# Remove Code: insert code for the remove method.

Notes on an interface

The list of types of note:

C# Header Text: insert text before declaring the interface.
C# Member Text: insert text in the interface body.
C# Bottom Text: insert text after declaring the interface.
C# Summary: add a comment to be used by the documentation tool.
C# Remarks: add a comment to be used by the documentation tool.
C# Attribute: add a C# attribute declaration zone.
C# Before Namespace Text: insert text before the namespace.
C# In Namespace Text: insert text after namespace opening.

Notes on a navigable association

The list of types of note:

C# Summary: add a comment to be used by the documentation tool.
C# Remarks: add a comment to be used by the documentation tool.
C# Initial Value: set initialization for the association.
C# Attribute: add a C# attribute declaration zone.
C# Setter Code: replace the code of the write accessor.
C# Getter Code: replace the code of the read accessor.

Notes on an operation

The list of types of note:

C# Summary: add a comment to be used by the documentation tool.
C# Remarks: add a comment to be used by the documentation tool.
C# Code: provide C# code to implement the operation.
C# Constructor Call: insert C# code before the pre-condition (especially for calling the parent class’ constructor).
C# Returned: insert C# code after the post-condition (especially for instructing the method return).
C# Exception Documentation: add documentation for exceptions thrown by the operation.
C# Header Text: insert text before declaring the operation.
C# Bottom Text: Insert text after declaring the interface.
C# Attribute: add a C# attribute declaration zone.

Notes on a parameter

The list of types of note:

C# Documentation: add a comment to be used by the documentation tool.