c语言编码规范（汇总）.ppt

3. 代码注释 必威体育精装版.课件 * 恰到好处的注释 1. 对重要变量说明其作用； 2. 对每一段函数代码加注释说明功能； 3. 对重要的语句加注释说明其功能； 4. 对重要的函数调用的参数加实际参数说明； 5. 在自己认为必要的地方加上注释 6. 可以采用/* */和//进行注释 必威体育精装版.课件 * 4. 基本编辑规范要求 正确使用：缩进，空格，空行 必威体育精装版.课件 * 缩进 根据语句间的层次关系采用缩进格式书写程序，每进一层，往后缩进一层 函数内的变量声明与执行语句要缩进一层 缩进长函数调用语句 pMsg = ComReadMsgFromQueue( aServer, NULL, ComWait_c, lTimeOut ); 一个缩进层次为四个英文字符宽度 一般用Tab键进行缩进，定义Tab为四个英文字符宽度 许多开发工具编辑器如VC一般会自动帮你缩进 必威体育精装版.课件 * 要加空格的场合 1. 在逗号后面和语句中间的分号后面加空格，如： int i, j, k; for (i = 0; i n; i++) Result = func(a, b, c); 2. 在二目运算符的两边各留一个空格，如 a b a = b i = 0 3. 关键字两侧，如if () …, 不要写成if() … 4. 类型与指针说明符之间一定要加空格： char *szName; 必威体育精装版.课件 * 不要加空格的场合 1. 在结构成员引用符号.和-左右两加不加空格：pStud-szName, Student.nID 2. 不要在行尾加多余的空格或Tab 3. 函数名与左括号之间不要加空格: func(…) 4. 指针说明符号*与变量名间不要加空格: int *pInt; 不要写成: int * pInt; 5. 复合运算符中间不能加空格，否则会产生语法错误，如： a + = b a = b 都是错误的 必威体育精装版.课件 * 空行与换行 1. 函数的变量说明与执行语句之间加上空行; 2. 每个函数内的主要功能块之间加空行表示区隔; 3. 一行语句不要写的太长，将长语句分成多行写; 4. 不要在一行中写多条语句. 必威体育精装版.课件 * 例子 int main() { int i, j, nSum = 0; //变量说明 for (i = 0; i 10; i++) //执行代码 { for (j = 0; j 10; j++) { nSum += i; } } } 注意空格 空行 注意各层缩进 必威体育精装版.课件 * 必威体育精装版.课件 * 必威体育精装版.课件 * 必威体育精装版.课件 * 必威体育精装版.课件 * 必威体育精装版.课件 * 必威体育精装版.课件 * 必威体育精装版.课件 * 必威体育精装版.课件 * 必威体育精装版.课件 * 必威体育精装版.课件 * 必威体育精装版.课件 * 编码规范 必威体育精装版.课件 * 第一部分 前言 Preface 必威体育精装版.课件 * 为什么要这么做？ 书写良好的代码更容易阅读 容易阅读的代码才容易被理解 容易被理解的代码才健康 编程风格体现了程序员对语言的理解水平 求职：好的编程风格给别人良好的第一印象，是获得高薪的第一步 必威体育精装版.课件 * 1. 编写目的 通过编程规范的学习和强制执行，使同学们从一开始就接触基本的软件开发思想，了解基本的软件工程规范，养成良好的编程习惯；为后续课程的实践环节和日后实际工作打下良好的基础；也便于教师批改与回复电子作业。 执行良好的编码规范可以使编写出来的程序易于阅读、理解和管理。 必威体育精装版.课件 * 2. 编码规范的定义 编码（coding）：是指用适当的代码编写工具编写C语言程序的源代码 编码规范： 相关英文说法：coding standard, coding convention, coding criterion 是指被普通采用的、或由某个企业或机构规定的，用计算机语言编写程序的过程中需要遵守的一套规则或约定的集合 编码规范并不是语言的语法规则 必威体育精装版.课件 * 3. 编码规范的应用 在软件业高速发展、团队开发成为基本开发模式的今天，几乎每个软件企业或软件开发团队都会制定各种各样的规范，应用于软件开发过程的各个环节中，编码规范是最基础规范之一。 不同的公司，对同一种开发语言，一般都采用类似的规范，也就是说编码规范具有一些通用性的标准 必威体育精装版.课件 * 4. 编码规范的学习和执行 要求学习和掌握规范标准 要求在本课程的作业过程中执行这些规范，上交的电子作业必须符合这些规范要求 要求在后续相关课程中执行此规范中的基本部分，并根据后续课程内容要求执行相应的扩展规范 必威体育精装版.课件 * 第二部分 C语言编码规范 Coding standards 必威体育精装版.课件 * 1. 文件级模块说明规范 File m