增加代码可读性——注释篇

程序员在写代码的时候，注意为代码加注释，并以合理的格式为代码加注释，这样可以方便别人查看代码

1. 逐层注释

 针对每个类：包括摘要信息、作者信息、以及最近修改日期等；

针对每个方法：包括用途、功能、参数和返回值等。

 

2. 使用分段注释

如果有多个代码块，而每个代码块完成一个单一任务，则在每个代码块前添加一个注释来向读者说明这段代码的功能。

3. 在代码行后添加注释

如果多行代码的每行都要添加注释，则在每行代码后添加该行的注释。

 

4.为自己添加注释

 即使是自己写的代码，三个月后看也会一脸茫然，为自己写注释，可以方便查找，以便维护。

 

5.边写代码边注释

 可以方便自己理清思路