首页 > 解决方案 > 如果方法上缺少 JavaDoc,CheckStyle 不会发出警告

问题描述

根据文档,我的 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>

标签: javajavadoccheckstylemaven-checkstyle-plugin

解决方案


推荐阅读