Javadoc @link 不同的 return 类型
Javadoc @link different return-types
@link
的 Javadoc 在 the two answers here 以及他们给定的 link 中有很好的解释。
不过我有一个问题:如何区分一种其他方面相似的方法的不同 return 类型?
假设我有以下两种方法:
public String doSomething(){
...
}
public int doSomething(){
...
}
在另一种方法中,我想 @link
仅 int doSomething()
。如果只有一种 doSomething()
方法,则 link 将类似于:
/*
* ...
* {@link com.example.package.MyClass#doSomething()}
*/
public void anotherMethod(){
...
}
我如何区分@link
中的不同return类型?
你不能有这样的方法,因为 Java 方法签名包括方法名称和参数类型,而不是结果类型。
假设您有不同的情况:一个方法名称,但不同的参数。在那种情况下,方法 link 应该包括参数类型。
/**
* This is {@link #doSomething(String)}
*/
public void doSomething(String string){
...
}
/**
* And this is {@link #doSomething(int)}
*/
public void doSomething(int integer){
...
}
@link
的 Javadoc 在 the two answers here 以及他们给定的 link 中有很好的解释。
不过我有一个问题:如何区分一种其他方面相似的方法的不同 return 类型?
假设我有以下两种方法:
public String doSomething(){
...
}
public int doSomething(){
...
}
在另一种方法中,我想 @link
仅 int doSomething()
。如果只有一种 doSomething()
方法,则 link 将类似于:
/*
* ...
* {@link com.example.package.MyClass#doSomething()}
*/
public void anotherMethod(){
...
}
我如何区分@link
中的不同return类型?
你不能有这样的方法,因为 Java 方法签名包括方法名称和参数类型,而不是结果类型。
假设您有不同的情况:一个方法名称,但不同的参数。在那种情况下,方法 link 应该包括参数类型。
/**
* This is {@link #doSomething(String)}
*/
public void doSomething(String string){
...
}
/**
* And this is {@link #doSomething(int)}
*/
public void doSomething(int integer){
...
}