中帝威Keilc编程规范.docVIP

中帝威C51编程规范（2010.11.02） 在项目的开发中，同一个项目的不同模块可能涉及不同成员来开发。养成一个良好的编程习惯，各成员按照同一个规范来开发项目，有助于后期工程的整合及彼此间意见的交流。在此制定此规范，供各位进行参考。 一 标志符命名法 变量: 由两部分组成，用 “ _ ” 分开，前半部分说明作用域，后半部分用小写字母说明类型，之后是一个大写字母开头的变量名称，如下：（作用域）_ （数据类型）（大写字母开始的名称）作用域：1、全局变量: g2、模块变量(在一个模块中公用的变量): m、。数据类型：1、字符：ch2、无符号字符uc3、整型i； 4、无符号整型： ui5、长整型：l6、无符号长整型：ul7、浮点数：f8、无符号浮点数：uf9、位变量：b【规则1-1】命名应当直观且可以拼读，可望文知意，便于记忆和阅读。标识符最好采用英文单词或其组合，不允许使用拼音。程序中的英文单词一般不要太复杂，用词应当准确。【规则1-】当标识符由多个词组成时，每个词的第一个字母大写，其余全部小写。比如：int CurrentValue；int iCurrent_Value；这样的名字看起来比较清晰，远比一长串字符好得多。【规则1-】对在多个文件之间共同使用的全局变量或函数要加范围限定符(建议使用模块名(缩写)作为范围限定符)Unsigned char g_ucKeyState; // 【规则1-】 例如：int x, X; /* 变量x 与X 容易混淆*/ void foo(int y); /* 函数foo 与FOO 容易混淆*/ void FOO(float y); 用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。 例如： int MinValue; int MaxValue; int MinValue(void); int MaxValue(void); 标识布尔型的变量或函数名称一般使用is作为前缀。 例如：void isFull()； 注意： 变量名的声明应该是每行一个变量，不要在一行声明多个变量。 变量尽量在定义的时候就进行初始化。 函数名： 函数名应用相应文件名作为前缀。每个词的第一个字母大写。例如，所有文件KEY.C中的函数和所有VIDEO.C中的函数都可以定义成如下形式: 补充：单词之间也可加下划线割开。 KEY.C KeyGetChar() KeyGetLine() 或者 Key_Get_Char() Key_Get_Line() VIDEO.C VideoGetAttr() VideoPutChar() 或者 Video_Get_Attr() Video_Put_Char() 二 定义语句 1．常数和宏定义要用大写，相应的词用下划线分开。例如： #define KEY_CR 0x0D #define KEY_START 0x01 三 程序版式 3.1 空行（4条规则） 空行起着分隔程序段落的作用，空行得体将使程序的布局更加清晰。空行不会浪费内存，所以不要舍不得用空行。 【规则3-1-1】在函数内部局部变量定义结束之后处理语句之前要加空行。 【规则3-1-2】在每个函数定义结束之后都要加空行。参见示例3-1（a）。 【规则3-1-3】函数返回语句和其他语句之间使用空行分开。 【规则3-1-4】在一个函数体内，逻辑上密切相关的语句之间不加空行，其它地方应加空行分隔。参见示例3-1（b）。 例如： 示例3-1(a) 函数之间的空行 示例3-1(b) 函数内部的空行 3.2 代码行（5条规则＋1条建议） 【规则3-2-1】一行代码只做一件事情，如只定义一个变量，或只写一条语句。这样的代码容易阅读，并且方便写注释。 【规则3-2-2】if、for、while、do 等语句自占一行，执行语句不得紧跟其后。不论执行语句有多少都要加{}表明是一个语句块。 【规则3-2-3】一对花括号要单独各占一行。但是在do-while、struct和union及其后有‘；’的除外，要同在一行。 【规则3-2-4】switch语句中的每个case语句各占一行，当某个case语句不需要break语句最好加注释声明。 【规则3-2-5】并列的语句行应该按照字母顺序排序，如变量定义和switch中的case语句等。 【建议3-2-1】尽可能在定义变量的同时初始化该变量（就近原则）