【问题标题】:Understanding CheckStyle JavadocMethod Rule了解 CheckStyle JavadocMethod 规则
【发布时间】:2012-03-12 16:47:41
【问题描述】:
/**
* set myMethod
* @param param1
* @param param2
* @param param3
* @param param4
*/
public void myMethod(ClassAA param1, ClassBB param2, HashMap<String, String> param3, Set<String> param4) {code}

当我在上面的代码上运行 checkstyle 时,它​​告诉我有这样的错误 “'param1' 的预期 @param 标记”。 我想了解,当标签存在时,为什么 checkstyle 将它们报告为错误。

谢谢

【问题讨论】:

  • 添加变量描述

标签: java checkstyle


【解决方案1】:

你想要这样的东西:

/**
* set myMethod
* @param param1 the AA to use for extracting the reference data
* @param param2 BB processing options
* @param param3 table of user parameters
* @param param4 set of active keywords
*/

【讨论】:

    【解决方案2】:

    您的文档中缺少文档 - 请描述参数。

    【讨论】:

    • 参数已经在文档中,正如我所分享的。不知道我需要提供哪些其他文件,您可以给我发送解决方案吗?
    猜你喜欢
    • 2017-01-23
    • 2020-05-12
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2011-03-08
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多