Unmatched Parameter tag found JAVA-D1004
Documentation
Major
6 months ago
—
a year old
@param tag for squidConfig refers to a nonexistent parameter
95 return args.toArray(new String[0]);
96 }
97
98 /** 99 * Set up the given CxxSquidConfiguration from the JSON compilation database100 *101 * @param squidConfig102 * @param compileCommandsFile103 * @throws IOException104 */105 public void parse(File compileCommandsFile) throws IOException {
106
107 LOG.debug("Parsing 'JSON Compilation Database' format");@param tag for language refers to a nonexistent parameter
38 private final VisualStudioTestResultsFileParser visualStudioTestResultsFileParser;
39 private final NUnitTestResultsFileParser nunitTestResultsFileParser;
40
41 /**42 * CxxUnitTestResultsAggregator43 *44 * @param language C or C++45 * @param settings SQ Configuration46 */47 public CxxUnitTestResultsAggregator() {
48 this(new VisualStudioTestResultsFileParser(), new NUnitTestResultsFileParser());
49 }@param tag for settings refers to a nonexistent parameter
38 private final VisualStudioTestResultsFileParser visualStudioTestResultsFileParser;
39 private final NUnitTestResultsFileParser nunitTestResultsFileParser;
40
41 /**42 * CxxUnitTestResultsAggregator43 *44 * @param language C or C++45 * @param settings SQ Configuration46 */47 public CxxUnitTestResultsAggregator() {
48 this(new VisualStudioTestResultsFileParser(), new NUnitTestResultsFileParser());
49 }
Description
This method/constructor's parameter tags don't match its declared parameters.
This may confuse people who read the method's documentation. Remove/replace the misplaced tags so that each parameter has a matching JavaDoc description.
Bad Practice
In the example below, someMethod does not have any parameter named nonexistant, but its Javadoc states that such a
parameter exists. This may have happened due to a refactor that changed a parameter's name, or, as in this case, removed
an existing parameter.
/**
* Some method.
*
* @param someParam - Does something.
* @param nonexistant - Doesn't exist.
* @return the result of this operation.
*
*/
String someMethod(int someParam) {
// ...
Recommended
Make sure to only document parameters that actually exist.
/**
* Some method.
*
* @param someParam - Does something.
* @return the result of this operation.
*
*/
String someMethod(int someParam) {
// ...
References
- Oracle technical blog - How to write JavaDoc comments