代码整洁之道——注释

注释：

1. 如果想在右括号的后面增加注释，那么你要做的是缩短代码（昨天刚经历过）

2. 位置标记不要滥用，否则就会陷入背景噪声之中。

function///
//去掉多余无用的斜杠

3. 源代码控制系统是代码归属与名命的最好归属地。比如Git。

4. 能用函数或是变量表示意思就不要用注释，用变量更好的表示自己的意思。

if(smodule.getDependSubsystems().contains(subSysMod.getSubSystem()))

ArrayList mouduleDependees = smodule.getDependSubsystems();
String ourSubSystem = subSysMod.getSubSystem();
if(mouduleDependees.contains(ourSubSystem ));

5. 对于一个函数，内参的注释，不需要每一个都有注释，可以使用表意的变量，否则就是废话。

6. 不当的注释具备一定的误导性，如果描述出错，调用函数的人会崩溃。

7. 大胆的删除注释掉的代码吧，不会丢的。

8. 为只做一件事的函数取一个好名字胜过注释。