了解CheckStyle JavadocMethod规则

Question

/**
* 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会在标签出现时将它们报告为错误。

谢谢

Answer 1

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

Answer 2

你想要的东西：

/**
* 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
*/