如果缺少方法上的JavaDoc,则不会发出CheckStyle警告

时间:2019-10-25 22:02:28

标签: java javadoc checkstyle maven-checkstyle-plugin

根据documentation,我的CheckStyle配置看起来还不错,但是似乎我错过了一些东西,因为如果JavaDoc缺少公共方法的前面,它并没有警告我。

如果类中缺少JavaDoc,我的配置会警告我,但如果任何公共方法中也缺少JavaDoc,我希望得到警告。

示例类:

/**
 * Say something.
 */
public class Kkkk {
    public void aaaaa() {
    }
}

我的CheckStyle配置:

<module name="TreeWalker">
    <module name="JavadocMethod">
        <property name="scope" value="public"/>
        <property name="allowMissingParamTags" value="false"/>
        <property name="allowMissingThrowsTags" value="false"/>
        <property name="allowMissingReturnTag" value="false"/>
        <property name="allowedAnnotations" value="Override, Test"/>
        <property name="allowThrowsTagsForSubclasses" value="true"/>
        <property name="allowedAnnotations" value="Override, Test"/>
    </module>
</module>

0 个答案:

没有答案