【进阶修炼】——改善C#程序质量(10)

158，不要写冗余注释。

注释应该写代码没有表达的东西。 代码能够自我描述就不要加注释。

159，废弃的注释应该尽早删除。

废弃的注释由于年代太久远，已经和现在的代码逻辑不匹配了，这样的注释只会误导人，应该删除。

160，注释掉的代码。

这是一个灾难，没有人知道它还有没有用，一直被遗留下来，然后代码不断的腐朽下去，勇敢的删除它吧，版本管理工具会记得它。

160，死函数。

死函数，即没有被调用的函数，应该删除，版本管理工具会记得它。

162，死代码。

可以在条件语句如if，switch中找到，也可以在从不抛出异常的try/catch中找到，当设计改变时，死代码并不会随之更新，遇见此类死代码就删除它吧。

163，代码的垂直距离。

变量和函数应该在靠近被使用的地方定义。本地变量应该在首次被使用的地方定义。私有函数应该在其被首次使用的位置下面定义。垂直距离越短，阅读就更加容易。

164，保持前后一致。

如在一个函数中用request来持有HttpRequest对象。在另一个函数中也应该用同样的变量名持有HttpRequest。如果一个函数命名为GetHttpStream，则另一个对Socket的读取函数可以命名为GetSocketStream，这样就保持了对称性，便于查找。

持续更新中。。。