Javadoc Style

【原因分析】
Javadoc的注释格式不正确。可能的情况如下:
1、方法、参数或返回值的注释为空;
2、第一行注释没有以句号、问号或感叹号结束;
3、html标签不完整;
4、有不应该出现的html标签,可以出现的标签有:"a", "abbr", "acronym", "address", "area", "b", "bdo", "big", "blockquote", "br", "caption", "cite", "code", "colgroup", "del", "div", "dfn", "dl", "em", "fieldset", "h1" to "h6", "hr", "i", "img", "ins", "kbd", "li", "ol", "p", "pre", "q", "samp", "small", "span", "strong", "sub", "sup", "table", "tbody", "td", "tfoot", "th", "thread", "tr", "tt", "ul"。
 
【影响分析】
不正确或不完整的注释将会给代码的维护带来更大的难度,使java代码的可读性下降。
 
【修改建议】
在日常开发的时候养成良好的编码习惯,注释尽可能写得详细和完整。

你可能感兴趣的:(javadoc)