【问题标题】:Javadoc @link different return-typesJavadoc @link 不同的返回类型
【发布时间】:2017-05-24 18:05:46
【问题描述】:

@link 的 Javadoc 在the two answers here 及其给定的链接中得到了很好的解释。
不过我有一个问题:如何区分其他类似方法的不同返回类型?

假设我有以下两种方法:

public String doSomething(){
   ...
}

public int doSomething(){
   ...
}

在另一种方法中,我想将 @link 改为 int doSomething()。如果只有一个 doSomething() 方法,则链接将类似于:

/*
 * ...
 * {@link com.example.package.MyClass#doSomething()}
 */
public void anotherMethod(){
   ...
}

如何区分@link 中的不同返回类型?

【问题讨论】:

    标签: java hyperlink javadoc


    【解决方案1】:

    你不能有这样的方法,因为 Java 方法签名包括方法名称和参数类型,而不是结果的类型。

    假设您有不同的情况:一个方法名称,但不同的参数。在这种情况下,方法链接应该包含参数类型。

    /**
    * This is {@link #doSomething(String)}
    */
    public void doSomething(String string){
       ...
    }
    
    /**
    * And this is {@link #doSomething(int)}
    */    
    public void doSomething(int integer){
       ...
    }
    

    【讨论】:

    • 啊,你是完全正确的!.. 我在一个类中添加了一些方法的链接,并注意到我有两个具有不同返回类型的相同方法,但结果是是不同的名字(一个字符差异,我已经重命名了一个,所以现在更容易发现差异)..我可以使用假期..再次感谢。我几乎想删除我的愚蠢问题,但我会让你得到你的答案的代表。 :)
    猜你喜欢
    • 2019-04-10
    • 2012-12-05
    • 2019-11-15
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2017-10-21
    • 2020-03-05
    相关资源
    最近更新 更多