当前位置:首页 > C++编码规范
c++编码规范 V1.2
【规则3-23】 在程序块的结束行右方加注释标记,以表明某程序块的结束。说明:当
代码段较长,特别是多重嵌套时,这样做可以使代码更清晰,更便于阅读。
【规则3-24】 注释应考虑程序易读及外观排版的因素,使用的语言若是中、英兼有的,
建议多使用中文,除非能用非常流利准确的英文表达。说明:注释语言不统一,影响程序易读性和外观排版,出于对维护人员的考虑,建议使用中文。
4、源代码结构
【规则4-1】 本规范规定源代码结构必须符合如下规范:
? 源代码目录结构如下:
根目录 doc include src win32 win32_release linux linux_release
? 源代码目录结构说明如下:
名称 说明 doc 存放源代码相关的说明文档及通过Doxygen生成的源代码注释文档 include 存放程序使用的库程序的头文件及本程序提供给外部使用的头文件 src 存放程序中与平台无关的源代码 win32 存放Windows平台相关的源代码及Windows平台下的工程文件、编译临时文件和编译后的目标程序文件(debug和release版) win32_release 存放Windows平台程序使用的库程序(dll和lib)及本程序提供给外部使用的库程序(dll和lib)(注:要求debug和release
Page 9 of 10
c++编码规范 V1.2
linux linux_release 版本对应的库程序文件不同,例如在debug版本的库文件名后附加字符“d”); 存放本程序编译的release版本程序文件 存放Linux平台相关的源代码及Linux平台下的工程文件、编译临时文件和编译后的目标程序文件(debug和release版) 存放Linux平台下本程序使用的库程序及本程序提供给外部使用的库程序; 存放Linux平台下本程序编译的release版本程序文件 注:
? 当需要同时编译成VC6和VS2005目标程序时,可以创建多个
“win32_release”目录,目录名称可通过附加后缀进行区分,例如“win32_release.net”。
? 当需要同时编译成支持不同内核版本的Linux目标程序,可以创
建多个“linux_release”目录,目录名称可通过附加内核版本作为后缀进行区分。
附录A:常见单词缩写表
单词 source destination command program send sender receive receiver
缩写 src dst cmd prg snd sndr recv recvr Page 10 of 10
共分享92篇相关文档