CheckStyle不会在接口方法上标记缺少的JavaDoc

问题描述 投票:0回答:1

有谁知道为什么CheckStyle不会在接口方法上标记缺少的JavaDoc,只是在实际的实现方法上?

假设我有以下,

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

这将在实际的类方法中报告缺少的JavaDoc,但在接口方法中不报告。

还尝试添加这个,没有用:

<property name="tokens" value="INTERFACE_DEF"/>
<property name="tokens" value="INTERFACE_DEF, CLASS_DEF"/>

类似的帖子,我得到了这个(但没有工作):qazxsw poi

有什么办法迫使checkstyle JavadocType only on interfaces检查接口方法?

原因:Spring Data是JPA库,它基于仅接口的方法名称,其中基于JavadocMethod注释配置器在幕后提供实现。因此,我们没有自己的实现。因此,在这种情况下,我们需要在接口方法上检查并要求JavaDoc。

java interface checkstyle
1个回答
1
投票

@Query

这就是为什么。如果行数为2或更大,则指定需要javadoc。接口没有任何行数,因此这就是您没有遭到任何违规行为的原因。

<property name="minLineCount" value="2"/>
© www.soinside.com 2019 - 2024. All rights reserved.