软件构造（2）

java注释
一、基本规则
1.注释应该使代码更加清晰易懂
2.注释要简洁明了，只要提供能够明确理解程序必要的信息就可以了。如果注释太复杂会影响程序整洁度和阅读感。
3.注释不仅描述程序作了什么，还要描述为什么这样做以及约束。
4.对于一般的getter和setter方法不用注释。
5.类、接口、构造函数、方法、全局变量必须添加注释。字段属性可以选择添加简单注释。
6.简单注释一般不超过10个字。
7.特殊地方必须要添加注释。比如一下几个地方：典型算法，代码不明晰处，在代码修改处，在循环和逻辑分支组成代码处，为他人提供的接口。
二、三种注释方式
1.单行注释（single-line）：//注释内容
一次只能注释一行，一般是简单注释，用来简短描述某个变量或属性，程序块。
2.块注释（block）：/注释内容/
为了进行多行简单注释，一般不使用。
3.文档注释：/**注释内容 */
可以使用多行，一般用来对类、接口、成员方法、成员变量、静态字段、静态方法、常量进行说明。Javadoc可以用它来产生代码的文档。为了可读性，可以有缩进和格式控制。
文档注释常采用一些Javadoc标签进行文档的特定用途描述，用于帮助Javadoc产生文档

三、具体的都有哪些地方需要注释
1.文件开始必须写注释,告诉读者这个文件是什么,做什么用的,以及可能加上版权信息
2.每一个方法,应当写注释
3.每一个变量创建时,特别是类的成员变量,应当写注释解释这个变量扮演的角色
4.规格说明,前置条件和后置条件
5.如何确保线程安全需要写注释说明
6.测试类中,需要用块注释写测试策略