Generating code comments (Java code)
ACS generates code comments.
ACS generates the text of an item's Description property as Java single line comments or a Java document comment that precedes the code generated for that item. The Description property is generated as a Java document comment only when the first character of the Description property is an asterisk.
ACS does not generate multi-line comments.
Generating single line comments
In the following example, ACS generates the Description property of Class1 as two single line comments.
|
Modeler
|
Generated code
|
|---|---|
 |
//Description of Class1 line1
//Description of Class1 line2 public class Class1 { } |
Generating Java document comments
In the following example, the first character of the Description property is an asterisk so ACS generates the Description property of Class1 as a Java document comment.
|
Modeler
|
Generated code
|
|---|---|
 |
/**Description of Class1 line1
Description of Class1 line2*/ public class Class1 { } |