Umple Comments
Comments and Requirements
noreferences
@@tooltip Ways to specify comments in Umple code

@@description
Comments provide a mechanism to document your work to provide some insight into
<i>why</i> you are performing a certain action, as opposed to simply showing
<i>how</i>.

<p>
Comments should be used just like in any programming language.
</p>

<p>
Comments immediately before <a href="ClassDefinition.html">class definitions</a>, <a href="AttributeDefinition.html">attribute definitions</a>, <a href="AssociationDefinition.html">association definitions</a> and <a href="MethodDefinition.html">method definitions</a>, as well as comments embedded in methods will be output into the generated code. Comments before definitions in Java will use Javadoc style; this means that when you generate JavaDoc output the API documentation will contain the comments. You are encouraged to create your Java comments using <a href="https://docs.oracle.com/javase/7/docs/technotes/tools/solaris/javadoc.html#javadoctags">Javadoc tags.</a>
</p>

<p>
Comments can be either <a href="InlineComments.html">inlineComments</a>, or <a href="MultilineComments.html">multilineComments</a>.
</p>

<br />

@@example @@caption Example Showing Inline Comments @@endcaption
@@source manualexamples/UmpleComments1.ump
@@endexample

@@example @@caption Example Showing Both Inline And Multiline Comments @@endcaption
@@source manualexamples/UmpleComments2.ump
@@endexample
