《内部编程规范--测试版》由会员分享,可在线阅读,更多相关《内部编程规范--测试版(14页珍藏版)》请在金锄头文库上搜索。
1、暑假竞赛编程规则暑假竞赛编程规则2011.7.92011.7.92011.7.92011.7.9*如有疑问或建议请联系如有疑问或建议请联系 尹栋尹栋( ( ( (短号短号 660432)660432)660432)660432)、李标、李标( ( ( (短号短号 630034)630034)630034)630034) 我们将进一步完善此规则我们将进一步完善此规则*1目录目录第一章第一章 程序书写格式程序书写格式.3 3 3 31.1 缩进.31.2 空格.31.3 换行.41.3.1 函数参数多的时候,最好要换行.41.3.2 条件语句也应该在必要时换行(便于逻辑思维).41.4 空行.41
2、.5 对齐.5第二章第二章 命名与定义规则命名与定义规则.6 6 6 62.1 概述-整体原则.62.2 变量命名规则.72.2.1 指针变量 “p”+变量类型前缀+命名.72.2.2 全局变量用 g_开头.72.2.3 静态变量用 s_开头.72.3 函数命名.7第三章第三章 函数注释函数注释.8 8 8 83.1 注释基本原则.83.2 文件注释.83.3 函数注释.93.3.1 函数头部注释.93.3.2 代码注释.93.3.3 变量、常量、宏的注释.9第四章第四章 语法统一性规则语法统一性规则.10101010暑假竞赛编程规则暑假竞赛编程规则2011.7.92011.7.92011.7
3、.92011.7.9*如有疑问或建议请联系如有疑问或建议请联系 尹栋尹栋( ( ( (短号短号 660432)660432)660432)660432)、李标、李标( ( ( (短号短号 630034)630034)630034)630034) 我们将进一步完善此规则我们将进一步完善此规则*2第五章第五章 程序模块化程序模块化.111111115.1 程序模块化简介.115.2 程序模块化实例.125.2.1KeyBoard 的 C 文件:.125.2.2KeyBoard 的 H 文件:. 135.2.3 其他的 C 文件和 H 文件仿照上面的形式进行编译.135.2.4 主函数为 C 文件:
4、.14暑假竞赛编程规则暑假竞赛编程规则2011.7.92011.7.92011.7.92011.7.9*如有疑问或建议请联系如有疑问或建议请联系 尹栋尹栋( ( ( (短号短号 660432)660432)660432)660432)、李标、李标( ( ( (短号短号 630034)630034)630034)630034) 我们将进一步完善此规则我们将进一步完善此规则*3第一章第一章 程序书写格式程序书写格式1.11.11.11.1 缩进缩进缩进缩进一个缩进一般是一个 TAB 键或是 4 个空格。强制要求用 TAB 键,缩进禁止用空格。缩进应该是每个程序员都会做的。但是仍然有不缩进的程序,或
5、是乱缩进的程序,如果我们的团队还有写程序不缩进的人,我们将毫不犹豫的开除他,并以破坏源码罪起诉他,还要他赔偿读过他程序的人的精神损失费。缩进,这是不成文的规矩。1.21.21.21.2 空格空格空格空格语句中要在各个操作符间加空格,函数调用时,要在各个参数间加空格。有效的利用空格可以让你的程序读进来更加赏心悦目。 而不会出现一堆表达式挤在一起。看看下面的代码:ha=(ha*128+*key+)%tabPtr-size;ha = ( ha * 128 + *key+ ) % tabPtr-size;有空格和没有空格的感觉不一样吧。暑假竞赛编程规则暑假竞赛编程规则2011.7.92011.7.92
6、011.7.92011.7.9*如有疑问或建议请联系如有疑问或建议请联系 尹栋尹栋( ( ( (短号短号 660432)660432)660432)660432)、李标、李标( ( ( (短号短号 630034)630034)630034)630034) 我们将进一步完善此规则我们将进一步完善此规则*41.31.31.31.3 换行换行换行换行1.3.11.3.11.3.11.3.1 函数参数多的时候,最好要换行函数参数多的时候,最好要换行CreateProcess(NULL,cmdbuf,bInhH,dwCrtFlags,envbuf,NULL,1.3.21.3.21.3.21.3.2 条件
7、语句也应该在必要时换行(便于逻辑思维)条件语句也应该在必要时换行(便于逻辑思维)if ( ch = 0temp = KEYNULL;/代码省略return temp ;/响应用户按的一个键, 返回一个正确的键值uchar ReadKey( void )uint j,k;/代码省略return ScanKey(); / 返回键值,如果不等继续等键值暑假竞赛编程规则暑假竞赛编程规则2011.7.92011.7.92011.7.92011.7.9*如有疑问或建议请联系如有疑问或建议请联系 尹栋尹栋( ( ( (短号短号 660432)660432)660432)660432)、李标、李标( ( ( (短号短号 630034)630034)630034)630034) 我们将进一步完善此规则我们将进一步完善此规则*135.2.25.2.25.2.25.2.2KeyBoardKeyBoardKeyBoardKeyBoard 的的 H H H H 文件文件:#ifndef _KeyBoard_h /条件编译,编译过就不再向下编译#define _