编程日记(43)

梁肇新 
2001年 43期

　　1999年10月25日  星期五  晴
　　　　公司来了几位新员工，我喜欢年轻人，很有冲劲和激情。他们的根基都不错，不过大多因为入行比较晚，在代码书写的规范化方面存在不少问题。我告诉他们，为了做一个好的程序员，一定要养成“代码编程规范化”的习惯，这样制作的代码才能是开放式的，开发团队中的每一个人写的代码合在一起就像一个人写的一样，这样才能够开发出好的程序。常见的代码规范大家多少都知道一些，但一些细微的地方仍然需要注意：
　　#1　　书写格式统一化
　　　　代码书写采用统一的风格，包括TAB的设置，比如设置为8，此时如果用8个空格代替，表面上看效果一样，但实际代码的内容会增加。
　　#1　　注释
　　　　不单注释部分的位置有讲究（一般情况下，代码行注释在代码之前，细微注释放在代码行之后），而且对于文中任何一个注释，不论多少，一定要将该部分的作用和原理进行简单清晰地说明，包括主要功能、接口函数、工作原理等。更细微的部分还要包括进行改动后添加的注释，而不是只修改只注明时间。
　　#1　　函数和变量的命名
　　　　统一按照Windows的命名风格，用有意义的单词进行命名。一般文件名指针用lpFileName而不是file_name这种方式，函数名也一样。指针类型的变量用lp开头，字符串类型变量用sz开头。整数类型可以用dw开头也可以直接命名。注意变量名本身要与其意义相接近。
　　　　一般常用变量的命名方式有：循环变量用i，j，k，l等单一字母，其他任何非计数变量不得用单字母变量；计数变量用Cnt，Count，Counter等；返回值变量用Ret；一般数值变量用Val，Value；全局变量必须有含义的英文单词，而且以小写g开头，即gXXX以示区别；类内变量除自动生成的变量为m_XX形式外，其他变量一律不使用下划线变量，但可以用mXXX方式以表示为类内变量；位置变量用X，Y，x，y;Pos，Xpos等；用width，high，height，wide等定义宽高；一个文件中的函数要引用另一个文件上的全局变量，直接在此函数内说明，不要放在文件开头，以避免不必要的变量冲突；一个文件内使用的全局变量以static来说明，以防止被其他文件意外使用；函数的说明方式，提供外部使用的函数必须加上PUBLICAPI，非引出函数的局部函数使用LOCALAPI来说明。
　　　　听了这些，他们都感慨在代码书写前还有这么多学问，都说受益匪浅，我心里也很高兴！
　　
　　 
 