Note types for Java¶
Overview¶
Modelio Java Designer notes are used to complete the UML model with texts
expressed in Java syntax. Usually, the internal processing of a UML method is
entered in Java in a “JavaCode” type note associated to a method's
implementation.
Note: Certain notes can be added to certain model elements directly
through the “Java” tab. For more information, please see “Java Designer
property view”.
Type of notes on a class¶
The ... type of note | Label | Is used to... |
JavaHeader | Header | insert a text before declaring the class. |
JavaMembers | Members | insert a text in the class body. |
JavaBottom | Bottom | insert a text after declaring the class. |
Javadoc | Javadoc | add a comment to be used by javadoc. |
JavaTop | Top | insert a comment before the java file's package instruction. |
JavaAnnotation | Annotations | specify the annotations added to the class. |
Type of notes on an operation¶
The ... type of note | Label | Is used to... |
Javadoc | Javadoc | add a comment which will be used by javadoc. |
JavaCode | Code | provide Java code for implementing the operation. |
JavaReturned | Return code | insert Java code after the post-condition (especially for instructing the method return). |
JavaAnnotation | Annotations | specify the annotations added to the operation. |
Type of notes on an attribute¶
The ... type of note | Label | Is used to... |
JavaInitValueComment | Comment on the initial value | add a comment about the attribute. |
Javadoc | Javadoc | add a comment to be used by javadoc. |
JavaAnnotation | Annotations | specify the annotations added to the attribute. |
Type of notes on an association end¶
The ... type of note | Label | Is used to... |
JavaAnnotation | Annotations | specify the annotations added to the association. |
Javadoc | Javadoc | add a comment to be used by javadoc. |
JavaInitValue | Initial value | set initialization for the association. |
JavaInitValueComment | Comment on the initial value | add a comment after the initialization of a navigable association. |
Type of notes on a package¶
The ... type of note | Label | Is used to... |
JavaAnnotation | Annotations | specify the annotations added to the package. |
Type of notes on a datatype¶
The ... type of note | Label | Is used to... |
Javadoc | Javadoc | add a comment to be used by javadoc. |
JavaHeader | Header | insert a text before declaring the class. |
JavaMembers | Members | insert a text in the class body. |
Type of notes on a dependency¶
The ... type of note | Label | Is used to... |
SeeJavadoc | See Javadoc | contain the format of a @see annotation. |
Type of notes on an enumeration¶
The ... type of note | Label | Is used to... |
JavaAnnotation | Annotations | specify the annotations added to the enumeration. |
JavaCode | Code | specify the Java code to add in the enumeration. |
Javadoc | Javadoc | add a comment to be used by javadoc. |
Type of notes on an enumeration literal¶
The ... type of note | Label | Is used to... |
JavaAnnotation | Annotations | specify the annotations added to the enumeration literal. |
JavaCode | Code | add Java code to this literal. |
Javadoc | Javadoc | add a comment to be used by javadoc. |
Type of notes on an interface¶
The ... type of note | Label | Is used to... |
JavaAnnotation | Annotations | specify the annotations added to the interface. |
JavaBottom | Bottom | insert a text after declaring the interface. |
Javadoc | Javadoc | add a comment to be used by javadoc. |
JavaHeader | Header | insert a text before declaring the interface. |
JavaMembers | Members | insert a text in the interface body. |
JavaTop | Top | insert a comment before the Java file's package instruction. |
Type of notes on a jar file¶
The ... type of note | Label | Is used to... |
AntTarget | Ant target | allow custom targets to be added in the generated ant file. |
Type of notes on a parameter¶
The ... type of note | Label | Is used to... |
JavaAnnotation | Annotations | specify the annotations added to the parameter. |
Javadoc | Javadoc | add a comment to be used by javadoc. |