软件开发规范(一)

为了提高软件开发质量，降低开发周期，增强代码的可重用性和易读性，使软件便于维护，开发人员间便于交流和协作，特总结出开发规范，以为参考。

一． 原则：

1． 软件工程化
2． 模块化
3． 能简单不复杂
4． 强调团队协作
5． 强调创新和特色

二． 具体规范：

1． 命名规范
命名应尽量使用匈牙利命名法，变量名或函数名中使用大写字符来区分各个部分，以便于记忆和阅读。如bPatchMinute, DeleteDirInfo()。全局(包括类中的)变量用长名字，局部变量用短名字。
类成员变量前一般应加上m_，全局变量加上g_，仅与本模块有关的变量加上l_,紧接着是变量的类型。
整型： n,i
长整型: l
无符号整型： u
无符号长整型：dw
字符： ch
布尔量： b
浮点数: f
双精度浮点: d
字符串： str,lpsz,sz,p,lp,ac,
指针： p
字节指针： pb
无符号指针： pv
字符指针： lpsz
整型指针： lpn
文件指针： fp
如：
m_nTotalNum,m_strPath,m_bRcving,m_fPrice,g_lOpenDate,g_dwCardNo,lpszNameStr, lpnSysDoomType,uMsgID,m_pProgress

局部变量应尽量易懂简洁，使用常见的变量，如
Num,nCount,i,j,k,n,len,pos, offset,nReadNum,index,nRet,ret, string,filename
临时变量，如ltmp,ftmp,tmpStr,tempStr,

函数命名也应该见名知意。如CalcAllDataStyle(),ReadDocDataFromTime(),GetIndexInfo()
常见的函数
Init, OpenAll, Create_, Get_, Set_, Read_, Load_, Write_, Start_, Stop_, Check_, Test_, Fill_, Process_, Sort_, Do_, Select_, Is_, Exist_,_Ex。

宏命名和typedef定义类型应详细，避免重复，一律为大写，如

#define DEL_EMPTY(a) {if (a) {delete a;a=NULL;}}
#define SUCCESS 0
#define FAIL -1

typedef struct
{
char lpzSource[100];
char lpzTitle[100];
char lpzURL[194];
short nType;
long npos;
long nlen;
}ATTBODY,*LPATTBODY; （指针前加LP）

自定义消息从WM_USER开始
#define MYAPP_MESSAGE WM_USER 0x1001

2． 代码规范
有些不易理解的变量或函数应作注释，难懂的代码要有注解，在文件的开始处有该文件的用途描述。一定要保持注释的一致性。

代码组织要清晰，{,},(,),if,else,do,while,for,case等要对应整齐，少用空格，缩进全部用Tab键。变量的定义要集中，函数间要有空行分开，一个程序中的空行数目最好占8%-16%。多态函数和功能相近的函数集中放在一起。

代码应该简洁、清楚并讲述了所发生的一切，我们的目标应该是写出最清晰的代码，而不是最巧妙的代码。例如如果是MFC多文档程序，就要严格按照其生成的框架写代码。尽量使用编译器已经提供的函数，不必花时间另行编写。例如系统已经有qsort函数，可直接拿来排序用。

某些公用代码要注意多平台易移植，最好使用标准C。

代码的重用要仔细，要将相关的代码也拷贝过来，注意那段代码也许不适合你的应用场合。

删掉从来没有用过的函数或变量，大篇幅注释掉的代码行也应删除，以免使程序混乱难读。

3． 工程文件组织规范
一个工程往往包含很多很多文件（*.h,*.cpp,*.inc,*.lib,资源文件等），向工程中加入文件或删除工程中的文件要慎重，避免把工程损坏。工程中不起作用的文件或类应删除，工程目录下的非工程文件也应该移走，保持工程的清洁，避免混淆难于管理。工程文件如果很多，应归类。

在VC环境下，建议将常用的头文件全部放入stdafx.h中，而在每个cpp开始处嵌入stdafx.h。避免头文件的交叉引用，如果有严重的交叉引用，适当使用类的声明。

将独立性比较强的模块抽出来，做成DLL，控件或COM组件，该模块可单独编写和测试，也增强了其可重用性。

一个比较大的工程应留有一定的消息接口或插件接口等。

工程的版本控制要严格，版本格式为xx.xx.xx，必要时使用Build次数或日期。高版本尽量兼容低版本的用法、数据或协议。

工程的编译宏定义和工程参数设置应正确，每作一个新工程时应检查工程参数是否正确。
建议字节对齐方式为1字节对齐。

工程文件应经常备份，备份时注明备份日期和主要增加的功能。

4． 类组织规范
类一般有两个文件，一个头文件，一个实现体CPP。

类力求封装好，严格区分public,private,protect等作用域，如果一个函数与本类有莫大的关系，可以作为该类的静态成员函数，不用或少用友元函数等破坏类封装性的方法和技巧。 如果一些结构或宏仅与本类有关，可在类头文件中定义。

类的成员变量在构造函数或初始化函数中应赋初值。指针在构造函数中赋NULL,析构时DEL_EMPTY它，以免内存泄露。

5． 用户界面规范
有四大类型的用户界面：对话框、单文档界面、多文档界面、其它界面

对话框要易用且简洁，字体和控件的组织搭配要得体，能简单不复杂，各控件的焦点、Tab顺序等要讲究，视应用场合要适当支持键盘。在简洁易用的前提下，力求个性化，设计得更加友好。程序各对话框的风格要保持一致。

单文档和多文档界面的程序功能可以做得很强，也便于扩充和管理。其中菜单、工具栏、状态栏等设计要有特色。菜单按一定的分类弹出，必要时设计成多套菜单，在重要的窗口或区域应能弹出右键，实现常见操作。工具栏上放最常用的操作按钮，必要时动态更换按钮。状态栏显示足够多的有用信息。
消息主控在Mainframe中，单文档的主控也可在View中，所有的对话框的弹出或非模态对话框的控制都在主控窗口中完成，具体的数据处理放在单独的文件中或设计成类。在App类中实现Ini读写，各数据对象的定义和析构，全局变量的赋值和初始计算，存盘退出等。各视图的OnDraw和GDI画图尽量使用内存位图的方式，以免闪烁。

其它还有ATL，控制台，嵌入式程序界面等，也有作为其它容器如IE中的插件等，此类程序可能不用MFC，而采用COM组件等方法实现。

6． 疑难解答和Bug调试方法
勤问、善于问。在不打扰正常工作的前提下，开发人员间应相互帮助，聚思广益，也许你的问题或Bug就是他人的前车之鉴。

标签：

版权申明：本站文章部分自网络，如有侵权，请联系：west999com@outlook.com
特别注意：本站所有转载文章言论不代表本站观点，本站所提供的摄影照片，插画，设计作品，如需使用，请与原作者联系，版权归原作者所有