简体   繁体   中英

CheckStyle: JavaDoc <p> Separator Violations

I have the following JavaDoc, with a <p> separator but (1) no blank lines and (2) the text after <p> continues on the next line, all of which is normal.

/**
 * 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;

In CheckStyle, my configuration is per the spec to allow full flexibility with <p> formatting:

    <module name="JavadocParagraph">
        <property name="allowNewlineParagraph" value="true"/>        
    </module>

But after refreshing, CheckStyle still reports 2 problems with the <p> :

在此处输入图片说明

- <p> tag should be preceded with an empty line.
- <p> tag should be placed immediately before the first word, with no space after

Any idea how to get rid of both of these?

在 IntelliJ IDEA 2020 中,选择/突出显示有问题的注释并重新格式化(Shift + Command + L)。

The technical post webpages of this site follow the CC BY-SA 4.0 protocol. If you need to reprint, please indicate the site URL or the original address.Any question please contact:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM