欢迎来到天天文库
浏览记录
ID:38374962
大小:188.00 KB
页数:15页
时间:2019-06-11
《通用编码规范(C++)》由会员上传分享,免费在线阅读,更多相关内容在教育资源-天天文库。
1、项目编号版本号密级机密XXXX软件编码规范(C++)V1.0.0作者编写时间审核审核日期批准批准日期KZH版权所有未经KZH的书面许可,不得以任何形式提供给任何第三方。KZH软件编码规范(C++)版本1.0.0历史版本记录日期版本说明作者2011-10-14V1.0.0初稿KZH内部资料,未经许可请勿传播ÓKZH,201115/15KZH软件编码规范(C++)版本1.0.0目录1.引言41.1编写目的41.2参考资料42.编码规范42.1程序命名规范42.1.1目标文件命名规范42.2程序编写格式52.2.1版权和版本信息声明52.
2、2.2头文件结构62.2.3程序版式62.2.4注译规范102.3变量命名规范112.3.1类名规则112.3.2变量和参数112.3.3常量112.3.4静态变量122.3.5全局变量122.3.6其他变量122.3.6类的数据成员122.3.7常见变量命名规则132.4函数编写规则132.4.1函数命名规则132.4.2函数编写规则132.4.3函数参数规则142.5程序配置142.5版本控制142.6异常处理规范14内部资料,未经许可请勿传播ÓKZH,201115/15KZH软件编码规范(C++)版本1.0.01.引言1.1编
3、写目的为规范项目组日常开发编码,统一项目组内部编码风格,提高项目组代码的可读性和可维护性,定制项目组本编码规范。1.2参考资料《高质量C++编程》2.编码规范2.1程序命名规范2.1.1目标文件命名规范在进行项目开发之前项目组需要事先约定好目标文件的名称和文件命名规则,包含如下内容:项目子项说明EXE/DLL/LIB执行文件KZHXXXX.exeXXXX:用英文缩写表示若英文较长,则使用英文首字母缩写表示。或者去掉单词中元音字母的方式命名配置文件XML优先选择XML,大的工程使用XML格式的配置文件注册表设备硬件设置、配置INI尽量
4、避免使用INI文件文件目录存放规则执行文件存放Bin目录,存放exe,dll,ocx配置文件存放在Cfg目录数据文件存放Data目录Trace文件存放在Trace目录临时文件存放在Tmp目录备份文件存放在Bak目录内部资料,未经许可请勿传播ÓKZH,201115/15KZH软件编码规范(C++)版本1.0.02.2程序编写格式2.2.1版权和版本信息声明每个程序文件中都要包含版权和版本信息的声明,格式如下:/***************************************************************
5、*******版权声明:KZH公司©版权所有*内容摘要:*描述文件的内容*当前版本:*作者:*修改记录:**********************************************************************标签说明1修改人修改时间,版本号*修改目的*修改内容,*1.修改内容1*2.修改内容2**n.修改内容n**********************************************************************标签说明2修改人修改时间,版本号*修改目的*修改内
6、容,*1.修改内容1*2.修改内容2**n.修改内容n*********************************************************************/关键字说明标题描述示例标签说明程序缩写_4位序号KzhHfr.dll程序HFR_0001,表示第一次修改KzhHfr.dll程序添加、删除、修改单行时在修改行后添加//HFR_0001添加、删除段落时可用下面的表示//HFR_0001BEGIN//HFR_0001END程序员可根据实际情况自行决定使用哪种方式。修改人张三则为sanzhang,
7、李小四则为xsli内部资料,未经许可请勿传播ÓKZH,201115/15KZH软件编码规范(C++)版本1.0.0使用公司邮箱登录名,且全部为小写字母修改时间修改时间年月日(YYYY-MM-DD)如2009-01-05修改目的简要概述本次修改解决的问题修改内容本次修改所修改的程序点可以有很多点。在程序修改之后编写,主要描述对程序的改动注:(1)在工程中单独创建一个KZHVersionHistory.h文件来存放工程版权和版本信息声明.(2)每个.h(除KZHVersionHistory.h)都有一个版权和版本信息声明(不保存修改内容
8、)及类功能简要描述。2.2.2头文件结构头文件结构包括三部分:(1)版本声明(2)预处理(3)函数和类结构声明规则如下:/********************************************************
此文档下载收益归作者所有