Java方法注释详解

方法注释必须紧靠在方法定义的前面，主要声明方法参数、返回值、异常等信息。

除去能够使用通用标签之外，还可以使用下面的的以@开始的标签：

方法注释例子：

/**
* @param num1: 加数1
* @param num2: 加数2
* @return: 两个加数的和
*/
public int add(int num1,int num2) {
int value = num1 + num2;
return value;
}

上面的代码当中，add()方法中声明了两个形参，并且将它们两个的和作为返回值返回。

为类的构造方法添加注释的时候，通常声明这个方法的参数信息。

下面是代码：

public class Student
{
String name;
int age;
/**
* @description: 构造方法
* @param name: 学生姓名
* @param age: 学生年龄
*/
public Student(String name, int age)
{
this.name = name;
this.age = age;
}
}