User Manual    [Previous]   [Next]   

Umple Comments

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

Comments should be used just like in any programming language.

Comments immediately before class definitions, attribute definitions, association definitions and method definitions, 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 Javadoc tags.

Comments can be either inlineComments, or multilineComments.

Example Showing Inline Comments

// The Umple system is both fun
// and efficient to development with


      

Load the above code into UmpleOnline

Example Showing Both Inline And Multiline Comments

// The Umple system is both fun and
// efficient to development with

/* 
  This apple can only be compared to 
  other apples
*/

      

Load the above code into UmpleOnline