java 注释

注释(comments)

Java的注释有两种方式:单行注释 // 和 块注释 /* */

Java的注释按位置分为四种,分别放在四个地方

1. 标题注释(Title comments)
2. 介绍性注释
3. 块注释
4. 单行注释

1.标题注释

标题注释放在文件开始的地方,从第一行开始.

标题注释通常包括版权信息

2.介绍性注释

在包导入声明(import)的下方,类声明的上方.

主要介绍类的意图,功能和使用方法.

3.块注释

块注释放在类主体之中.

用于说明一块代码(多行相关代码)的作用

4.单行注释

放在一条语句的上方或者后面

用于解释一行语句的作用,通常放在调用函数后或者逻辑的复杂语句后面

那些地方需要注释

1. 文件开始必须写注释,告诉读者这个文件是什么,做什么用的,以及可能加上版权信息
2. 每一个类声明的时候应当有注释,解释这个类是做什么用的.注意同一个文件中可能有多个类,如内部类,这些类都需要写注释以表明他们的作用.
3. 每一个方法,应当写注释
4. 每一个变量创建时,特别是类的成员变量,应当写注释解释这个变量扮演的角色
5. 涉及复杂的算法时,应当为每一行写注释
6. 规格说明,前置条件和后置条件
7. 创建成员变量后的一系列单行注释说明: RI ,AF,表示不变性,防止表示泄露的策略
8. 如何确保线程安全需要写注释说明
9. 测试类中,需要用块注释写测试策略

图: RI,AF ,防止表示泄露策略

下图:线程安全的策略

下图:用块注释写测试策略