接触VC之二:MFC类基础,C++程序编写规范介绍(4)
二、函数的建议:
1.参数的定义位置要附和人性化,输出参数在前,输入参数在后。
2.如果参数是指针,且仅作输入用,则应在类型前加const,以防止该指针在函数体内被意外修改。
3.函数名如果是全局的应当加前缀Afx,函数名以有意义的可拼读的动词性英文单词或短语来命名,且每个英文语素首字母都就应当大写。如:AfxGetMessage(),Close()。
4.一般函数的返回值最好用来返回错误标志,而真正的返回值应当用输出参数来返回。
5.在函数的前几行,应当对入口参数进行有效性检查。
6.函数体的规模要小,尽量控制在50 行代码之内。否则,应当进行拆分。
7.函数体中不要声明使用静态变量,那样会使用函数难以控制。
三、 类的建议:
1.所有的成员变量应有m_前缀。
2.在类的声明体中应遵循公有,保护,最后私有,前函数,后成员的顺序进行声明。
3.不能在类的声明体中进行操作,这是不正确的,也是编译器所不允许的。即是初始化(例如:int m_nCount=0;)也不可以。
4.应当在一个以类名为名字,后缀为.h的文件中写入类的声明体,应当在一个以类名为名字,后缀为.cpp的文件中写入类的成员函数的实现语句。并且在.cpp文件的第一行写上#include “类名.h”。
四、其它的建议:
1.for,if,do,while等语句中,无论后面的语句是否为一行,必须用大括号括起来。
2.不可以在一行上写入多条语句,那样会使程序的可读性降低。
3.应当在不易理解的程序段或行上(比如内联汇编语句),加上注释。不要在显而易懂的语句上加上注释,(如:i++;)
4.在编程中,应当想到今后的可重性,给今后便于修改留下余地。
5.在要求技术性的程序上,尽量以最简捷的代码来完成功能。除非必要,否则不要去追求视觉界面效果。因为,界面代码要比功能代码混乱得多。会使代码不易维护。
6.应当将一些常用的功能整理成可以直接使用的类,这样不仅省功且使代码看起来简洁。如界面代码等。
7.在正式编程的时候,切勿直接编写代码。应当先规划好程序结构及其算法等程序实现,再去动手。因为在编程中重要的不是如何去代码,而是程序的实现方法。而且直接写码,肯定会导致程序代码的修修改改,使代码看起来很杂乱。
8.要习惯于在大部分时间去书写文档,因为程序关键是在于是否会被人能够接受使用。
9.要用70%的时间去设想程序的算法,要用27%的时间去书写文档,只能用1%的时间去编写代码,最后用2%的时间去调试代码。
(第二部分完)