关于编程风格小记

发现自己编程风格还真的有问题，对于我这个频繁爱忘事的人来说，还是写一下吧。

 

对于函数，为了以后便于复用，要把函数的功能尽可能地单一化，最好一个函数不要超过100行？...

为了便于阅读，比如版本升级了，别人或自己难免会再看程序，所以我们要把注释写好。

 

对于函数的注释，一般有以下四点，也就是函数的要素。

1.函数功能：函数是做什么的

2.输入参数：解释输入参数的含义

3.输出参数：解释输出参数的含义

4.返回值：返回不同的结果代表的含义

 

对于重要的函数，我们可以写上调用实例。比如调用 ： add(3, 4);

 

习惯得慢慢培养，刚开始这么写的时候，你肯定感觉很啰嗦。但长远看来，还是很值的。尤其是对于项目大点的话，说不定几个文件就能搞混，更不用说以后再进行优化了。ok, 从现在开始，咱们规范地写程序吧！

 

再就是一个情况，因为电脑的磁盘毕竟是有限的，所以我们在生成日志或测试文件的时候，不要太大。有一次生成了一个100多G的日志，把磁盘空间用完了（当然不是一天，而且我都忘了这会事了）。对于程序中生成的 以~结尾的文件，尽量也清除一下。这种文件太多以后，毕竟也挺占资源的。

 

2011.08.25