java的注释

注释：

这是一种用来说明程序程序相应部分的功能或是某个方法或者变量的含义，有时也会用来记录工程的进度，当有未完成的方法或者类的时候需要记录还未完成什么。注解还可以帮助我们自己在完成工程时候记录思路。不容易让逻辑混乱。在工作的时候（尤其是合作的时候）要求注释的总量至少要覆盖代码的90%的区域。在写注释的时候选择好相应的注释类型，不然还是很麻烦的。

在Java中有三种注解形式：

第一种是单行注释：这种注释只能在同一行进行说明，注释不能写到下一行，因为单行注释的作用范围只在一行上。无法涉及到下一行，不建议在单行注释上写太多太长。多作为变量的注释。//作为注释的开头。

第二种是多行注释：这种注释用来写较大量的注释，用来说明一种东西的功能。多行注释的写法是/*……/，其中的省略号表示程序员所写的注释。

第三种是文档注释：这种注释是一种比较特殊的注释，它里面的内容可以生成javadoc文档，这种注释一般是用来记录写作者的信息，类，方法，版本，始于什么jdk的版本以及类的介绍，方法功能的介绍等等。一般来说，对于类的介绍和方法的介绍是比较少用到的。这种注释的内容可以将每个人的责任分划清楚。

接下来我们就说一下那些必须加的基本注释：1.类或者接口的注释  2.变量的注释  3. 方法的注释（重载或者重写的方法尤其重要，但是那些get,set方法就不需要写注释了）  4.构造方法的注释

另外就是在一些特殊情况下必须加的注释：1.一些使用的算法（你就别管他是不是简单的算法）   2. 代码不清楚的部分，这样方便自己和他人观看。 3.循环和逻辑分支还有选择结构组成的代码中的注释。  4.当代码出现问题或者可能出现bug的部分或者已经修改的部分。 5. 为他人提供的接口还有抽象类（这个的注释必须详细）