自说明代码

要点

1. 该不该注释是个需要认真对待的问题。差劲的注释只会浪费时间，帮倒忙；好的注释才有价值。
2. 源代码应当含有程序大部分的关键信息。只要程序依然在用，源代码比其他资料都能保持更新，故而将重要信息融入代码是很有用处的。
3. 好代码本身就是最好的说明。如果代码太糟，需要大量注释，应先试着改进代码，直至无须过多注释为止。
4. 注释应说出代码无法说出的东西——例如概述或用意等信息。
5. 有的注释风格需要许多重复性劳动，以舍弃之，改用易于维护的注释风格。