如何在Javadoc中正确引用方法以及什么是{@link}?
大家好!我刚开始学习Java,正在为我的项目编写文档。我遇到了一个问题:我想在Javadoc注释中链接到另一个方法,以便文档阅读更方便。例如,我有一个`Calculator`类,包含`add()`和`sumAndPrint()`方法。在第二个方法的描述中,我想指出它调用了`add()`。
我尝试过直接写`#add`或`{@link add}`,但这不起作用——生成的HTML文档中没有显示链接。官方文档提到过`{@link #methodName}`,但我不清楚如果方法在另一个类中或带有参数时,如何正确指定完整路径。
以下是我的代码示例:
```java
/**
* 用于简单算术运算的计算器。
*/
public class Calculator {
/**
* 将两个数相加。
* @param a 第一个数
* @param b 第二个数
* @return a与b的和
*/
public int add(int a, int b) {
return a + b;
}
```