注意:本节注释使用文档注释。多行注释的内容不能用于生成一个开发者文档(文档提供类、方法和变量的解释,也可称为帮助文档),而文档注释可以。
/** * @projectName(项目名称): project_name * @package(包): package_name.file_name * @className(类名称): type_name * @description(类描述): 一句话描述该类的功能 * @author(创建人): user * @createDate(创建时间): datetime * @updateUser(修改人): user * @updateDate(修改时间): datetime * @updateRemark(修改备注): 说明本次修改内容 * @version(版本): v1.0 */提示:以上以
@
开头的标签为 Javadoc 标记,由@
和标记类型组成,缺一不可。@
和标记类型之间有时可以用空格符分隔,但是不推荐用空格符分隔,这样容易出错。/** * @author: zhangsan * @createDate: 2018/10/28 * @description: this is the student class. */ public class student{ ................. }注意:没有必要在每一行的开始用
*
。例如,以下注释同样是合法的:
/** @author: zhangsan @createDate: 2018/10/28 @description: this is the student class. */ public class student{ ................. }
@
开始的标签。
/** * @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; } }
/** * 用户名 */ public String name;也可以使用如下格式:
/**用户名*/ public String name;在 Java 的编写过程中我们需要对一些程序进行注释,除了自己方便阅读,更为别人更好理解自己的程序。注释对于程序的可读性来说是非常重要的,希望读者不要忽视它。
本文链接:http://task.lmcjl.com/news/10474.html