This shows you the differences between two versions of the page.
Both sides previous revision Previous revision | Next revision Both sides next revision | ||
ch02-getting-going.html [2017/08/20 18:17] mithat [Comments] |
ch02-getting-going.html [2017/08/20 18:18] mithat [Comments] |
||
---|---|---|---|
Line 178: | Line 178: | ||
=== doc comment === | === doc comment === | ||
- | The doc comment is a special case of the multiline comment. It's short for "documentation comment." Its rules and behavior are identical to the multiline comment with one important difference: There is a tool available to Java programs (the platform on which Processing is based) called ''javadoc'' that when applied to a source file will find all the doc comments and produce nicely formatted and pretty documentation. | + | The doc comment is a special case of the multiline comment. It's short for "documentation comment." Its rules and behavior are identical to the multiline comment with one important difference: There is a tool available to Java programs (the platform on which Processing is based) called ''javadoc'' that when applied to a source file will find all the doc comments and produce nicely formatted and pretty documentation from them. |
To turn a mutiline comment into a doc comment, just add an additional ''*'' in the opening tag: | To turn a mutiline comment into a doc comment, just add an additional ''*'' in the opening tag: |