TouchInstinct
/
checkstyle
306
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Issue #410: fix for formatting at writingjavadocchecks.xml.vm

This commit is contained in:
Roman Ivanov 2016-05-06 06:44:45 -07:00
parent d08ee6db62
commit d3cd6a2508
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/xdocs/writingjavadocchecks.xml.vm
View File

@ -40,9 +40,9 @@ public class MyClass {
* @see AbstractClass
]]></source>
</p>
Attention that java comment is start with <source>/*</source>, following with Identificator of comment type. Javadoc Identificator is <source>*</source>. All symbols after Javadoc Identificator till <source>*/</source> are part of javadoc comment. In internet you can find different types of documentation
Attention that java comment is start with <code>/*</code>, following with Identificator of comment type. Javadoc Identificator is <code>*</code>. All symbols after Javadoc Identificator till <code>*/</code> are part of javadoc comment. In internet you can find different types of documentation
generation tools similar to javadoc. Such tools reply on different Identificators: "!", "#", "$".
Comments looks like "/*! some comment */" , "/*# some comment */" , "/*$ some comment */". Such multiline comments are not a javadoc.
Comments looks like <code>"/*! some comment */"</code> , <code>"/*# some comment */"</code> , <code>"/*$ some comment */"</code>. Such multiline comments are not a javadoc.
</section>
<section name="Limitations">