JavadocMethod:当@param标记实际存在时，应出现该标记错误

Question

我收到以下检查样式错误

[ERROR] src\main\java\com\disney\wdpr\dclm\personalization\base\service\mapper\PaymentSvcMapper.java:[45,46] (javadoc) JavadocMethod: Expected @param tag for 'retrievePersonByPersonIdPayerResponse'.
[ERROR] src\main\java\com\disney\wdpr\dclm\personalization\base\service\mapper\PaymentSvcMapper.java:[46,33] (javadoc) JavadocMethod: Expected @param tag for 'fidelioPostResponse'.
[ERROR] src\main\java\com\disney\wdpr\dclm\personalization\base\service\mapper\PaymentSvcMapper.java:[46,62] (javadoc) JavadocMethod: Expected @param tag for 'personId'.
[ERROR] src\main\java\com\disney\wdpr\dclm\personalization\base\service\mapper\PaymentSvcMapper.java:[46,89] (javadoc) JavadocMethod: Expected @param tag for 'blist'.
[ERROR] src\main\java\com\disney\wdpr\dclm\personalization\base\service\mapper\PaymentSvcMapper.java:[46,103] (javadoc) JavadocMethod: Expected @param tag for 'paymentType'.
[ERROR] src\main\java\com\disney\wdpr\dclm\personalization\base\service\mapper\PaymentSvcMapper.java:[47,21] (javadoc) JavadocMethod: Expected @param tag for 'routedPId'.

但是我的代码在指定的函数和行号中包含@param标记。

/**
 * @param retrievePersonByPersonIdPayerResponse
 * @param fidelioPostResponse
 * @param personId
 * @param blist
 * @param paymentType
 * @param routedPId
 * @return
 */
public static PaymentResponse mapPaymentRequest(
        RetrievePersonByPersonIdResponse retrievePersonByPersonIdPayerResponse,
        FidelioPostResponse fidelioPostResponse, Integer personId, HashSet<Integer> blist, String paymentType,
        Integer routedPId) {

敬请指教。

Answer 1

这是因为您只列出了参数，而没有解释它们。你的javadoc是在浪费空间，它不会添加任何代码中没有的东西。

下面是一个最小的例子：

public class Test {
    /**
     * @param theFoo what to foo
     */
    public String foo(String theFoo) {
        return theFoo;
    }
}

当我在它上面运行javadoc时，我得到了一个类似的抱怨：

robert:~$ javadoc Test.java
Loading source file Test.java...
Constructing Javadoc information...
Standard Doclet version 14.0.1
Building tree for all the packages and classes...
Generating ./Test.html...
Test.java:3: warning: no description for @param
     * @param theFoo
       ^
Test.java:5: warning: no @return
    public String foo(String theFoo) {
                  ^
...

只需添加一点解释来修复它：

public class Test {
    /**
     * @param theFoo what to foo
     * @return the same foo
     */
    public String foo(String theFoo) {
        return theFoo;
    }
}

您不会收到关于它的警告，但老实说，您的Javadoc应该在第一个@param之上解释该方法做了什么。