如果缺少方法描述则显示警告

Question

在我们的代码库中，我看到了很多类似的方法：

/**
     * @param tagID
     * @param startDate
     * @param endDate
     * @param estimated
     * @return
     * @throws ServerException
     */
    List<String> generateMaster(int tagID, Date date)
            throws ServerException, BusinessException;

虽然有 javadoc，但缺少方法的描述。因此，javadoc 显然是无用的。在checkstyle中，我该怎么做才能对上述情况发出警告。

<property name="allowMissingJavadoc" value="false"/>

这只检查是否存在 javadoc。它将上述方法标记为 present 因为存在 javadoc。但是实际上缺少方法声明。

PS：标记eclipse和intellij。我对任何解决方案都很满意，它告诉我包含上面的方法的数量，比如 javadocs

Answer 1

我们将其用于 checkstyle 中的 javadoc：

<module name="JavadocStyle">
    <property name="severity" value="warning"/
    <property name="checkEmptyJavadoc" value="true"/>
</module>

如您所见checkEmptyJavadoc应该对您有所帮助。

Answer 2

这个 post 可能为时已晚 - 但任何其他想要找到答案的人，请为每个元素添加描述，例如

/**
 * @param tagID - ID of the tag
 * @param startDate - Starting Date
 * @param endDate - End date
 * @param estimated <-- this is not the param - should be removed or fix doc
 * @return <-- missing return param and description
 * @throws ServerException -- throws server exception
 */

如果缺少方法描述则显示警告

Show warning if method description is missing

java

eclipse

intellij-idea

checkstyle