better C/C++ code（一）——注释

前辈们总说代码要详细注释、给后人创造好的再利用和维护条件。

 

然而事实是，再编写和调试所谓“艰难代码时”，程序员也很痛苦，让他们同时兼顾添加详细注释也实在是不堪重负。一则，代码能否需要再次修改并不确定；二则，项目完成后，公司基本不会给时间recode，一般都是聚餐、旅游...等等

 

其实代码注释也可以这样写：

a.代码注释尽量写在.h文件里,仅需写出作者、时间、功能、注意事项

b.实现代码尽量依靠变量名和函数名等的含有完成“自注释”

c.严禁变量一语多用

d.函数只能有一个出口

g.不使用类的继承，而利用类的多态性重新包装，减少注释。（C++之父曾说：“多重继承  是一场灾难”）