黑马程序员-（高新技术）注释

• ------- <a href="http://www.itheima.com" target="blank">android培训</a>、<a href="http://www.itheima.com" target="blank">java培训</a>、期待与您交流！ ----------
  
• 注释概述：

解相当于一种标记，在程序中加了注解就等于为程序打上了某种标记，没加，则等于没有某种标记，

以后，javac编译器，开发工具和其他程序可以用反射来了解你的类及各种元素上有无何种标记，

看你有什么标记，就去干相应的事。标记可以加在包，类，字段，方法，方法的参数以及局部变量上。

定义一个简单的注释：

public @interface ZhuShi {}

• 使用注释：

@Retention(RetentionPolicy.RUNTIME)//设置注解在什么时候有效
@Target({ElementType.METHOD,ElementType.TYPE})//设置注解可以使用那里（方法，属性，类）
public @interface ZhuJie {//创建一个注解


String color() default"red";//注释可以添加的一些属性，可以书设置缺省值
String value();//类型可以是很多
int[] arr();
JiaoTongDeng lamp();
ZhuShi zhushi();
}

• 注释详解：

如果模块只进行部分少量代码的修改时，则每次修改须添加以下注释：
//Rewriter
//Rewrite Date：<修改日期:格式YYYY-MM-DD> Start1：


//End1：
将原代码内容注释掉，然后添加新代码使用以下注释：
//Added by
//Add date：<添加日期，格式：YYYY-MM-DD> Start2：
//End2：
如果模块输入输出参数或功能结构有较大修改，则每次修改必须添加以下
注释：
//Log ID：<Log编号,从1开始一次增加>
//Depiction：<对此修改的描述>
//Writer：修改者中文名
//Rewrite Date：<模块修改日期，格式：YYYY-MM-DD>


2、接口注释：
接口注释采用，在满足类注释的基础之上，接口注释应该包含描述接口的目的、它应如何被使用以及如何不被使用，块标记部分必须注明作者和版本。在接口注释清楚的前提下对应的实现类可以不加注释。


3、构造函数注释：
构造函数注释采用 ，描述部分注明构造函数的作用，不一定有块标记部分。
注释模版一：

• 注释模版二：

4、函数注释：
函数注释采用，在每个函数或者过程的前面要有必要的注释信息，包括：函数或过程名称；功能描述；输入、输出及返回值说明；调用关系及被调用关系说明等。函数注释里面可以不出现版本号（@version）。

• 注释模版一：

5、方法注释：
方法注释采用 ，对于设置 (Set 方法 ) 与获取 (Get 方法 ) 成员的方法，在成员变量已有说明的情况下，可以不加注释；普通成员方法要求说明完成什么功能，参数含义是什么且返回值什么；另外方法的创建时间必须注释清楚，为将来的维护和阅读提供宝贵线索。


6、方法内部注释：
控制结构，代码做了些什么以及为什么这样做，处理顺序等，特别是复杂的逻辑处理部分，要尽可能的给出详细的注释。
   
7、 全局变量注释：
要有较详细的注释，包括对其功能、取值范围、哪些函数或者过程存取以及存取时注意事项等的说明。


8、局部（中间）变量注释：
主要变量必须有注释，无特别意义的情况下可以不加注释。


9、实参/参数注释：
参数含义、及其它任何约束或前提条件。


10、字段/属性注释： 字段描述，属性说明。


11、常量：常量通常具有一定的实际意义，要定义相应说明。

• 总结：

注释是J2SE5.0提供的一项非常有趣且使用的功能。

EJB3规范就是借助于注释实现的。这样将使EJB3在实现起来更简单，更人性化。

还有Hibernate3除了使用传统的方法生成hibernate映射外，也可以使用注释来生成hibernate映射。。