1.14 Java注释:类、方法和字段注释
一个程序的可读性,关键取决于注释。如果一个程序想二次开发,要读懂前面的程序代码,就必须在程序中有大量的注释文档,所以对于一个优秀的程序员来说,学会在程序中适当地添加注释是非常重要的。
注释除了帮助别人了解编写的程序之外,还对程序的调试、校对等有相当大的帮助。当程序具体运行时,计算机会自动忽略注释符号之后所有的内容。教程第二章中曾经提到过注释,读者也许印象不太深,在这里复习一遍。
本节将简单地介绍类、方法、字段等地方的注释方法,这些地方的注释虽然简单但是在开发工作中却是非常重要的。
注意:本节注释使用文档注释。多行注释的内容不能用于生成一个开发者文档(文档提供类、方法和变量的解释,也可称为帮助文档),而文档注释可以。
1. 类注释
类注释一般必须放在所有的“import”语句之后,类定义之前,主要声明该类可以做什么,以及创建者、创建日期、版本和包名等一些信息。以下是一个类注释的模板。
/**
- @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{.................
}
2. 方法注释
方法注释必须紧靠在方法定义的前面,主要声明方法参数、返回值、异常等信息。除了可以使用通用标签外,还可以使用下列的以@开始的标签。
- @param 变量描述:对当前方法的参数部分添加一个说明,可以占据多行。一个方法的所有
- @param 标记必须放在一起。
- @return 返回类型描述:对当前方法添加返回值部分,可以跨越多行。
- @throws 异常类描述:表示这个方法有可能抛出异常。
下面是一个方法注释的例子。
/*** @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;}
}
3. 字段注释
字段注释在定义字段的前面,用来描述字段的含义。下面是一个字段注释的例子。
/*** 用户名*/
public String name;
也可以使用如下格式:
/**用户名*/
public String name;
在 Java 的编写过程中我们需要对一些程序进行注释,除了自己方便阅读,更为别人更好理解自己的程序。
1.14 Java注释:类、方法和字段注释相关推荐
- Java注释:类、方法和字段注释
一个程序的可读性,关键取决于注释.如果一个程序想二次开发,要读懂前面的程序代码,就必须在程序中有大量的注释文档,所以对于一个优秀的程序员来说,学会在程序中适当地添加注释是非常重要的. 我们会简单地介绍 ...
- java遍历类中所有字段
代码: //遍历类中所有字段信息 https://blog.csdn.net/weixin_34346099/article/details/94036015public static void re ...
- mysql命令行如何查字段注释_mysql如何查看字段注释
mysql查看字段注释的方法:执行[show full columns from test]命令即可查看.如果我们要查看数据表的注释,可以执行[show create table test]命令. 具 ...
- Java的类,对象以及字段和方法
1 编码风格 代码风格一般规定:类名的首字母要大写,如果类由几个单词构成,那么吧它们并在一起(不要用下划线来分隔) 其中每个内部带刺的首字母都采用大写形式 例如 : class AllColorOf ...
- java包 类 方法_Java中包与包之间方法的调用及其关键字区分(基础)
最近在写应用时,对包与包之间方法的调用不太清楚,专门看视频和网站后整理了这篇文章,希望对刚入门的同志有所帮助,进入主题. 首先我们先简单看看Java中private.protected.public和 ...
- java获取参数上的注解_java-如何获取带注释的方法参数及其注释
在我的应用程序中,我有一些方法的参数带有一些注释.现在,我想编写Aspect,使用来自注释属性的信息对带注释的参数进行一些预处理.例如,方法: public void doStuff(Object a ...
- java学生类 方法 输出_高额悬赏,java面向对象编程,编写学生类,输出学生相关信息...
展开全部 学生类public class Student {//定义学生类 private String name;//属性e68a8432313133353236313431303231363533 ...
- 7.17 Java基础-类-方法-继承-多态
一.方法:有无参数,有无返回值,构造函数 无参构造函数:写了无参构造函数,那么程序在运行的时候会自动调用自己写的无参构造函数,如果没有写,在程序运行的时候会自动添加上无参构造函数. 但是有例外情况 构 ...
- java 实体类 时间格式字段注解
@DatetimeFormat是将String转换成Date,一般前台给后台传值时用 @JsonFormat(pattern="yyyy-MM-dd") 将Date转换成Strin ...
最新文章
- c#属性中的get和set属性
- 如何评价算法的好坏?
- [python] shell模式下面写for循环
- asp.net内置对象
- html的表单标记格式,HTML表单标签
- 【扯淡】今天看了《写给失眠者的心理学》,下面开始借鉴与脑洞大开
- addActionError addFieldErrot addActionMessage 的区别
- 下载 针式PKM V9.08 版
- vue.js2.0视频教程
- 5个最佳的Android测试框架(带示例)
- IDEA 插件开发实战
- Java毕业设计-疫情防控系统
- comsol 5.3 matlab,COMSOL5.3在Linux下的安装
- kdj超卖_KDJ超买超卖指标正确用法
- 修心修行“十一字”真言
- 空中网创始人杨宁:忽悠就是融资能力
- LaTex幻灯片制作
- SSH-keygen用法
- 卡尔曼滤波Kalman Filtering:介绍
- HashMap之keySet()方法
热门文章
- ML之DT:机器学习根据大量数据,已知年龄、收入、是否上海人、私家车价格的一个人,预测是否有真实购买上海黄浦区楼房的能力
- 中科院分词系统(NLPIR)JAVA简易教程
- JAVA_OA管理系统(二):SpringMVC笔记基础篇01注入方法
- 文件字符流 编码判断
- CozyRSS开发记录3-标题栏再加强
- 2016百度编程题:钓鱼比赛
- vim常用命令总结 (转)
- 【C#】三维立体验证码 (3DCaptcha)
- AB1601定时器timer0,timer1简介
- 微众WeCross 跨链平台(12)合约总结