Javadoc @link不同的返回类型

时间:2017-01-10 09:41:51

标签: java hyperlink javadoc

@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中的不同返回类型?

1 个答案:

答案 0 :(得分:3)

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

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

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

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