了解的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，它告诉我，有这样的 “为‘参数1’预期@param标识”的错误。 我想了解，为什么checkstyle在标签存在时将它们报告为错误。

谢谢

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

Answer 2

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