我总结的一些软件开发规范

一． 原则：

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。

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

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