一个程序的可读性，关键点就在于注释，下面要给大家讲到的就是Java注释方面的知识，主要会介绍java类注释
类注释一般必须放在所有的“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{
.................
}
对于类注释就为你介绍到这里了，希望上面的内容可以帮助到你，更多java基础知识，请继续来奇Q工具网了解学习吧。
推荐阅读：
