3.1.1 注释的使用

1. 块注释

块注释通常用于提供对文件、方法、数据结构和算法的描

述。

块注释被置于每个文件的开始处以及每个方法之前。
块注释之首应该有一个空行，用于把块注释和代码分隔开

来

2. 单行注释

单行注释可以显示在一行内，并与其后的代码具有同样的

缩进层级。

3. 尾端注释

极短的注释可以与它们所要描述的代码位于同一行，但是
应该有足够的空白来分开代码和注释。若有多个短注释出
现于大段代码中，它们应该具有相同的缩进。