Понимание правила JavadocMethod CheckStyle - PullRequest
0 голосов
/ 12 марта 2012
/**
* 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}

Когда я запускаю контрольный стиль в вышеприведенном коде, он говорит мне, что есть ошибки типа «Ожидаемый тег @param для« param1 »».Я хотел бы понять, почему checkstyle сообщает о них как об ошибке, когда есть теги.

Спасибо

Ответы [ 2 ]

1 голос
/ 12 марта 2012

Вы хотите что-то вроде:

/**
* 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
*/
1 голос
/ 12 марта 2012

В вашей документации отсутствует документация - опишите параметры.

...