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: zhangs