实验室内部C语言编程规范V10Word格式.docx

1、第8章 内存管理-25附录-26参考文献-27第1章 文件结构每个C程序通常分为两个文件。一个文件用于保存程序的声明（declaration），称为头文件，另一个文件用于保存程序的实现（implementation），称为定义（definition）文件。C程序的头文件以“.h”为后缀，C 程序的定义文件以“.c”为后缀。1.1 版权和版本的声明 版权和版本的声明位于头文件和定义文件的开头（参见示例 1-1），主要内容有： （1）版权信息；（2）文件名称，作者，当前版本号，完成日期，文件功能描述；（3）版本历史信息。/* Copyright （C）, 2009-2010, College of

2、 Auto. Hangzhou Dianzi Univ. File name: filename.c Author: xupingVersion: 1.0Date: 2009-11-5 Description: / 用于详细说明此程序文件完成的主要功能，与其他模块 / 或函数的接口，输出值、取值范围、含义及参数间的控 / 制、顺序、独立或依赖等关系 Others: / 其它内容的说明 History: / 修改历史记录列表，每条修改记录应包括修改日期、修改 / 者及修改内容简述 1. Author: Date: Modification: 2. Author: */示例1-1 版权和版本的声明

3、1.2 头文件的结构头文件由三部分内容组成：1） 头文件开头处的版权和版本声明；2） 预处理块；3） 函数和结构声明等。假设头文件名称为 filename.h，头文件的结构参见示例 1-2。/ 版权和版本声明见示例 1-1，此处省略。#ifndef FILENAME_H / 防止filename.h 被重复引用 #define FILENAME_H #include / 引用标准库的头文件 #include “myheader.h” / 引用非标准库的头文件 void function（）; / 函数声明 struct BOX_STRU / 结构声明 BOX;#endif示例1-2 头文件的结

4、构【规则 1-1】为了防止头文件被重复引用，应当用 ifndef/define/endif 结构产生预处理块。【规则 1-2】用 #include 格式来引用标准库的头文件（编译器将从标准库目录开始搜索）。【规则 1-3】用 #include “filename.h” 格式来引用非标准库的头文件（编译器将从用户的工作目录开始搜索）。【建议 1-1】头文件中只存放“声明”而不存放“定义”。【建议 1-2】不提倡使用全局变量，尽量不要在头文件中出现象 extern int value 这类声明。1.3 定义文件的结构定义文件有三部分内容：1） 定义文件开头处的版权和版本声明（参见示例 1-1）；2

5、） 对一些头文件的引用；3） 程序的实现体（包括数据和代码）。假设定义文件的名称为 filename.h，定义文件的结构参见示例1-3。#include “filename.h” / 引用头文件 / 函数的实现体 void function（） 示例1-3 定义文件的结构1.4 头文件的作用 C 语言的初学者虽然会用使用头文件，但常常不明其理，这里对头文件的作用略作解释：1）通过头文件来调用库功能。在很多场合，源代码不便（或不准）向用户公布，只要向用户提供头文件和二进制的库即可。用户只需要按照头文件中的接口声明来调用库功能，而不必关心接口怎么实现的。编译器会从库中提取相应的代码。2）头文件能加

6、强类型安全检查。如果某个接口被实现或被使用时，其方式与头文件中的声明不一致，编译器就会指出错误，这一简单的规则能大大减轻程序员调试、改错的负担。1.5 目录结构 如果一个软件的头文件数目比较多（如超过十个），通常应将头文件和定义文件分别保存于不同的目录，以便于维护。每一个工程都应尽可能将其用到的所有头文件及定义文件放到该工程目录下。头文件保存于工程目录下的include目录，将定义文件保存于source目录（可以是多级目录）。第2章 程序排版 2.1 空行 【规则 2-1】在每个类声明之后、每个函数定义结束之后都要加空行。参见示例2.1（a）。【规则 2-2】在一个函数体内，逻揖上密切相关的语

7、句之间不加空行，其它地方应加空行分隔。参见示例 2.1（b）。示例2-1（a） 函数之间的空行 示例2-1（b） 函数内部的空行/ 空行 void function1（） void function2（） void function3（） / 空行while （condition）statement1; / 空行 if （condition） statement2; else statement3;statement4;2.2 代码行 【规则 2-3】一行代码只做一件事情，如只定义一个变量，或只写一条语句。这样的代码容易阅读，并且方便于写注释。【规则 2-4】if、for、while、do 等

8、语句各占一行，执行语句不得紧跟其后。不论执行语句有多少都要加。这样可以防止书写失误。示例 2-2 风格良好的代码行int width; / 宽度 int height; / 高度 int depth; / 深度 x = a + b;y = c + d;z = e + f;if （width =”、“=”、“+”、“*”、“%”、“&”、“|”、“”这类操作符前后不加空格。【建议 2-2】对于表达式比较长的 for 语句和 if 语句，为了紧凑起见可以适当地去掉一些空格，如 for （i=0; i10; i+）和 if （a=b） & （c= 2000） / 良好的风格 if（year=2000

9、） / 不良的风格 if （a=d） / 良好的风格 if（a=b&c=d） / 不良的风格for （i=0; i+） / 良好的风格 for（i=0;ii+） / 不良的风格 for （i = 0; I 10; i +） / 过多的空格x = a b ? a : b; / 良好的风格x=afunction（）; / 不要写成 b - function（）;2.4 对齐 【规则 2-13】程序的分界符“”和“”应独占一行并且位于同一列，同时与引用它们的语句左对齐。【规则 2-14】 之内的代码块在“”右边数格处左对齐。示例2-5（a）风格良好的对齐 示例2-5（b）风格不良的对齐void fu

10、nction（int x） / program code void function（int x） if （condition） else if （condition） else update） update）while （condition） / program code / program code如果出现嵌套的，则使用缩进对齐，如：2.5 长行拆分 【规则 2-14】代码行最大长度宜控制在70至80个字符以内。代码行不要过长，否则眼睛看不过来，也不便于打印。【规则 2-15】长表达式要在低优先级操作符处拆分成新行，操作符放在新行之首（以便突出操作符）。拆分出的新行要进行适当的缩进，使排版

11、整齐，语句可读。示例 2-6 长行的拆分if （very_longer_variable1 = very_longer_variable12） （very_longer_variable3 = very_longer_variable14） （very_longer_variable5 = very_longer_variable16） do_something（）;int copy_person_address （PERSON_BASE_INFO_STRU PERSON_A, PERSON_BASE_INFO_STRU PERSON_B）;for （very_longer_initializ

12、ation; very_longer_condition; very_longer_update） 2.6 修饰符的位置【规则 2-16】应当将修饰符 * 和 & 紧靠变量名。char *name;int *x, y; / 此处 y 不会被误解为指针 示例 2-7 修饰符的位置第3章 注释C 语言的块注释符为“/*/”，行注释一般采用“/”。注释通常用于：1）版本、版权声明；2）函数接口说明；3）重要的代码行或段落提示。虽然注释有助于理解代码，但注意不可过多地使用注释。参见示例 3-1。【规则 31】程序中的注释不可喧宾夺主，应简洁明了。【规则 32】如果代码本来就是清楚的，则不必加注释。【规

13、则 33】边写代码边注释，修改代码的同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。【规则 34】注释应当准确、易懂，防止注释有二义性。【规则 35】尽量避免在注释中使用缩写，特别是不常用缩写。【规则 36】注释的位置应与被描述的代码相邻，可以放在代码的上方或右方，不可放在下方。【规则 37】当代码比较长，特别是有多重嵌套时，应当在一些段落的结束处加注释，便于阅读。【规则 38】注释与所描述内容进行同样的缩排。【规则 39】每个函数定义前都要求有函数功能、输入、输出等参数的说明。格式见示例3-1。示例3-1 程序的注释/* * 函数介绍：* 输入参数：* 输出参数：* 返回

14、值：*/ void function（float x, float y, float z） if （） while （） / end of while / end of if 【规则 3-10】对于所有的变量、常量，如果其命名不是充分自注释的，在声明时都必须加以注释，说明其含义。对分支语句（条件分支、循环语句等）必须编写注释。【规则 3-11】全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。参见示例3-2。/* The ErrorCode when SCCP translate */* Global Title failure, as foll

15、ows */ / 变量作用、含义/* 0 SUCCESS 1 GT Table error */* 2 GT error Others no use */ / 变量取值范围/* only function SCCP_translate（） in this modual can modify it, */* and other module can visit it through call */* the function get_trans_error_code（） */ / 使用方法char g_trans_error_code;示例3-2 全局变量的注释第4章 命名规则【规则 4-1】标

16、识符应当直观且可以拼读，可望文知意，可标识符最好采用英文单词或其组合，便于记忆和阅读。切忌使用汉语拼音来命名。【规则 4-2】标识符的长度应当符合“min-length & max-information”原则，即采用能代表变量或函数信息的最短长度字符即可。【规则 4-3】命名中若使用特殊约定或缩写，则要有注释说明。应该在源文件的开始之处，对文件中所使用的缩写或约定，特别是特殊的缩写，进行必要的注释说明。【规则 4-4】程序中不要出现仅靠大小写区分的相似的标识符。【规则 4-5】程序中不要出现标识符完全相同的局部变量和全局变量，尽管两者的作用域不同而不会发生语法错误，但会使人误解。【规则 4-

17、6】变量和函数的名字中，除了专有名词（如硬件设备，寄存器，标准和协议等等）部分以外采用大写，其余均采用小写与下划线混排的格式。参见示例4-1和示例4-2。【规则 4-7】全局变量以g_开头，后面紧接变量名，这样便于与局部变量区分。float old_value;int set_value（.）;示例4-1 基本的变量和函数命名规则int TCP_rev_buff1024;int USART_transmit_data（.）;示例4-2 含有专有名词的变量和函数命名规则【规则 4-8】常量、宏定义、自定义结构体的名字均采用大写与下划线混排的格式。参见示例4-3。示例4-3常量和结构的命名#def

18、ine RADIUS 100;const unsigned char RADIUS = 100;typedef struct PERSON_BASE_INFO_STRU unsigned char name8; unsigned char age; unsigned char sex; PERSON_BASE_INFO;【规则 4-9】变量的名字应当使用“名词”或者“形容词名词”。参见示例4-4。示例4-4 变量的命名float value;float new_value;【规则 4-10】函数的名字应当使用“动词”、“动词名词”（动宾词组）。参见示例4-5。示例4-5 函数的命名draw_b

19、ox（）;get_value（）;【规则 4-11】用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。参见示例4-6。示例4-6 互斥意义的变量和函数的命名int min_value;int max_value;int set_value（）;int get_value（）;【建议 4-1】尽量避免名字中出现数字编号，如 value1,value2 等，除非逻辑上的确需要编号。【建议 4-2】对于变量命名，禁止取单个字符（如i、j、k.），建议除了要有具体含义外，还能表明其变量类型、数据类型等，但i、j、k作局部循环变量是允许的。第5章 常量、变量和结构5.1 常量 常量是一种标识符，

20、它的值在运行期间恒定不变。C 语言用 #define来定义常量（称为宏常量）。如果不使用常量，直接在程序中填写数字或字符串，将会有什么麻烦？（1） 程序的可读性（可理解性）变差。程序员自己会忘记那些数字或字符串是什么意思，用户则更加不知它们从何处来、表示什么。（2） 在程序的很多地方输入同样的数字或字符串，难保不发生书写错误。（3） 如果要修改数字或字符串，则会在很多地方改动，既麻烦又容易出错。【规则 5-1】尽量使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串。【规则 5-2】需要对外公开的常量放在头文件中，不需要对外公开的常量放在定义文件的头部。为便于管理，可以把不同模块的常量集中存放在一个公共的头文件中。【规则 5-3