CheckStyle:JavaDoc;p>;分隔符违规
我有以下JavaDoc文档,有<p>
分隔符,但(1)没有空行,(2)<p>
之后的文本继续到下一行,所有这些都是正常的。
/**
* Fetches a list of Org beans based on the provided org code.
* <p>
* Note: This also takes care of Parent/Child orgs.
*
* @param org Organization string
* @return List of Org beans
* @throws Exception
*/
List<Org> loadOrgs(String org) throws Exception;
在CheckStyle中,我的配置是per the spec以允许使用<p>
格式的完全灵活性:
<module name="JavadocParagraph">
<property name="allowNewlineParagraph" value="true"/>
</module>
但刷新后,CheckStyle仍报告两个<p>
问题:
- <p> tag should be preceded with an empty line.
- <p> tag should be placed immediately before the first word, with no space after
有没有办法同时摆脱这两种情况?
解决方案
在IntelliJ Idea 2020中,选择/突出显示有问题的注释并重新设置其格式(Shift+Command+L)。
相关文章