CODEWITHSUNDEEP
javacheckstyle
nomi
nomi

Reputation: 441

Understanding CheckStyle JavadocMethod Rule

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

When I run the checkstyle on above code, It tells me that there are errors like this "Expected @param tag for 'param1'". I would like to understand , why checkstyle is reporting them as error, when the tags is there.

Thanks

Upvotes: 0

Views: 2492

Answers (2)

soru
soru

Reputation: 5526

You want something like:

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

Upvotes: 1

Rostislav Matl
Rostislav Matl

Reputation: 4543

There is documentation missing in your documentation - describe the parameters.

Upvotes: 1

Related Questions