第2章 C51程序设计基本规范.pptVIP

第2章 C 程序设计基本规范 　　　编程规范只是一个规范，也可以不遵守，但是要做一个有良好编程风格的程序员，就一定要遵守编程规范，不仅方便自己以后的阅读，也方便与其他程序员的交流。要做到这一点，程序员应遵循一定的规范并贯穿程序的始终。首要考虑的是程序的可行性、可读性、可移植性、可维护性及可测试性，这是总则。 /************************************************* Copyright (C), 1988-1999, Huawei Tech. Co., Ltd. File name:????? // 文件名 Author:????? Version:????? Date: // 作者、版本及完成日期 Description:??? // 用于详细说明此程序文件完成的主要功能，与其他模块 ???????????? // 或函数的接口，输出值、取值范围、含义及参数间的控 ???????????? // 制、顺序、独立或依赖等关系 Others:????? // 其它内容的说明 Function List: // 主要函数列表，每条记录应包括函数名及功能简要说明 1. .... History:????? // 修改历史记录列表，每条修改记录应包括修改日期、修改 ???????????? // 者及修改内容简述 1. Date: ? Author: ? Modification: 2. ... *************************************************/ 　　1) 头文件　　一个C源文件配置一个h头文件，或者整个项目的C文件配置一个h头文件，而一般采用整个项目的C文件配置一个h头文件的方法。头文件应该按固定的顺序编写，首先使用?#include包含语句编写本头文件中需要包含的其他头文件，其次声明函数原型，接着定义用到的数据常量。定义数据常量使用?#define语句，并且使用?#ifndef/#define/#endif宏来防止重复定义，方便各模块之间相互调用。 ? //预处理块及函数和类结构声明等 ? ? #ifndef ? GRAPHICS_H ? ?// ? 防止graphics.h被重复引用 ? ? ? #define ? GRAPHICS_H ? ? ? ? ? ? #include ? math.h ? ? ? ? ? ? // ? 引用标准库的头文件 ? ? ? … ? ? #include ? “myheader.h” ? ? // ? 引用非标准库的头文件 ? ? ? … ? ? ? void ? Function1(…); ? ? ? ? // ? 全局函数声明 ? ? ? … ? ? ? struct ? Box ? ? ? ? ? ? ? ? ? ? ? ? ? ? // ? 结构体声明 ? ? { ? … ? }; ? ? ? ? ? #endif 　　在每个文件的开头写清楚这个文件归属哪个项目里的哪个模块，是在什么编译环境下编译的，编程者(或修改者)和编程日期。值得注意的是，一定不要忘了编程日期，因为以后再看文件时，会知道大概是什么时候编写的，有些什么功能，并且可以知道类似模块之间的差异。对于一些固定的常量如圆周率PI或者常需要在调试时修改的参数最好用?#define定义，但要注意宏定义只是简单的替换，因此有些括号不可少。 　　2) 常量、变量、函数命名　　变量的命名应该能够反映变量的数据类型和含义，最好能做到见名知意。命名必须具有一定的实际意义。例如：　　常量的命名：全部用大写。　　变量的命名：变量名加前缀，前缀反映变量的数据类型，用小写；反映变量意义的第一个字母大写，其他小写。　　函数的命名：函数名首字大写，若包含有两个单词的，则每个单词首字母大写。函数原型说明包括引用外部函数及内部函数，外部引用必须在右侧注明函数来源(模块名及文件名)，内部函数只要注释其定义文件名。 /* active statistic task number */ #define MAX_ACT_TASK_NUMBER 1000 #define PI 3.1415926 char cLength; //长度int iMaxLength; //最大长度void DisplayNumber(int x,int y,char Number); //显示数值extern int KeyScan(); //键盘扫描（key.c） 　　3) 几条好的书写规范　　(1) 书写代码时要注意括号对齐，固定缩进。一个{ }各占一行，根据个人习惯，缩进4个