使软件便于维护开发人员间便于交流和协作特总结出
5页1、为了提高软件开发质量,降低开发周期,增强代码的可重用性和易读性,使软件便于维护,开发人员间便 于交流和协作,特总结出开发规范,以为参考。一. 原则:1. 软件工程化2. 模块化3. 能简单不复杂4. 强调团队协作5. 强调创新和特色二. 具体规范:1. 命名规范命名应尽量使用匈牙利命名法,变量名或函数名中使用大写字符来区分各个部分,以便于记忆和阅读。如 bPatchMinute, DeleteDirInfo()。全局(包括类中的)变量用长名字,局部变量用短名字。类成员变量前一般应加上m_,全局变量加上g_,仅与本模块有关的变量加上1_,紧接着是变量的类型。整型:n,i长整型:1无符号整型:u无符号长整型:dw字符: ch布尔量:b浮点数:f双精度浮点:d字符串:str,1psz,sz,p,1p,ac,指针:P字节指针:pb无符号指针:pv字符指针: 1psz整型指针: 1pn文件指针:fp如:m_nTota1Num,m_strPath,m_bRcving,m_fPrice,g_1OpenDate,g_dwCardNo,1pszNameStr,1pnSysDoomType,uMsgID,
2、m_pProgress局部变量应尽量易懂简洁,使用常见的变量,如Num,nCount,i,j,k,n,1en,pos, offset,nReadNum,index,nRet,ret, string,fi1ename临时变量,如 1tmp,ftmp,tmpStr,tempStr,函数命名也应该见名知意。如 Ca1cA11DataSty1e(),ReadDocDataFromTime(),GetIndexInfo()常见的函数Init, OpenA11, Create_, Get_, Set_, Read_, Load_, Write_, Start_, Stop_, Check_, Test_, Fi11_, Process_, Sort_, Do_, Se1ect_, Is_, Exist_,_Ex。宏命名和typedef定义类型应详细,避免重复,一律为大写,如#define DEL_EMPTY(a) if (a) delete a;a=NULL;#define SUCCESS 0#define FAIL -1typedef structchar lpzSource100;char l
3、pzTitle100;char lpzURL194;short nType;long npos;long nlen;ATTBODY,*LPATTBODY;(指针前加 LP)自定义消息从WM_USER开始#define MYAPP_MESSAGE WM_USER+0x10012. 代码规范有些不易理解的变量或函数应作注释,难懂的代码要有注解,在文件的开始处有该文件的用途描述。一定 要保持注释的一致性。代码组织要清晰,,(,),if,else,do,while,for,case等要对应整齐,少用空格,缩进全部用Tab键。变量的定义要集中,函数间要有空行分开,一个程序中的空行数目最好占8%-16%。多态函数和功能相近的 函数集中放在一起。代码应该简洁、清楚并讲述了所发生的一切,我们的目标应该是写出最清晰的代码,而不是最巧妙的代码。 例如如果是MFC多文档程序,就要严格按照其生成的框架写代码。尽量使用编译器已经提供的函数,不必 花时间另行编写。例如系统已经有qsort函数,可直接拿来排序用。某些公用代码要注意多平台易移植,最好使用标准么代码的重用要仔细,要将相关的代码也拷贝过来,注意那段代码也
4、许不适合你的应用场合。删掉从来没有用过的函数或变量,大篇幅注释掉的代码行也应删除,以免使程序混乱难读。3. 工程文件组织规范一个工程往往包含很多很多文件(*.h,*.cpp,*.inc,*.lib,资源文件等),向工程中加入文件或删除工程 中的文件要慎重,避免把工程损坏。工程中不起作用的文件或类应删除,工程目录下的非工程文件也应该 移走,保持工程的清洁,避免混淆难于管理。工程文件如果很多,应归类。在VC环境下,建议将常用的头文件全部放入stdafx.h中,而在每个cpp开始处嵌入stdafx.h。避免头文 件的交叉引用,如果有严重的交叉引用,适当使用类的声明。将独立性比较强的模块抽出来,做成DLL,控件或COM组件,该模块可单独编写和测试,也增强了其可重 用性。一个比较大的工程应留有一定的消息接口或插件接口等。工程的版本控制要严格,版本格式为xx.xx.xx,必要时使用Build次数或日期。高版本尽量兼容低版本的 用法、数据或协议。工程的编译宏定义和工程参数设置应正确,每作一个新工程时应检查工程参数是否正确。建议字节对齐方式为1字节对齐。工程文件应经常备份,备份时注明备份日期和主要增加
《使软件便于维护开发人员间便于交流和协作特总结出》由会员大米分享,可在线阅读,更多相关《使软件便于维护开发人员间便于交流和协作特总结出》请在金锄头文库上搜索。
吊装平台施工组织设计
4A教学计划、进度表20158.doc
八年级下人教新课标期中文化素质调研八年级试卷.doc
幼儿园美工活动方案参考范文(四篇).doc
2023年质量管理协会的上半年工作总结范文.docx
2023年爱岗敬业班主任辞职报告范文.docx
学习助我成长.doc
精益生产知识简介
清华老师的话受益了
2023护士实习报告个人总结(2篇).doc
中班科学优质故事教案详案《有趣的叶子宝宝》
2023年 春季开学典礼演讲稿 .docx
2023教师感恩的演讲稿100范文.docx
2023年魔术协会年度总结.docx
乡村旅游管理制度标准范文(7篇)
江苏省南京市第十三中学2021届高三生物上学期教学质量调研试题(三).doc
吵架道歉信
2023年篇一政风行风自查自纠整改落实方案.docx
2023年小蚂蚁历险记作文4范文.docx
2023年纪检监察工作心得体会.DOC
2023-06-24 32页
2023-04-24 16页
2023-01-09 6页
2022-08-16 37页
2022-10-31 12页
2023-12-23 5页
2023-01-12 3页
2024-01-16 3页
2022-08-05 1页
2022-08-16 11页