大二上实训语言编码.pdf

编码规范 第一部分前言 Preface 为什么要这么做？ ◼ 书写良好的代码更容易阅读 ◼ 容易阅读的代码才容易被理解 ◼ 容易被理解的代码才健康 ◼ 编程风格体现了程序员对语言的理解水平 ◼ 求职：好的编程风格给别人良好的第一印象， 是获得高薪的第一步 为什么要这么做？ ◼ IOCCC 国际 C代码大赛 include "stdio.h" main(int a, char *b[]) { for(a[b++]=" o,world!\n";(!!b)[*b]&&(a--||-- b&&execlp(*b,*b,b[!!b]+!!b,!b));**b =!b) write(!!*b, *b,!!**b); } 1. 编写目的 ◼ 通过编程规范的学习和强制执行，使 从一开始就接触基本的软件开发思想，了解 基本的软件工程规范，养成良好的编程习惯； 为后续课程的实践环节和日后实际工作打下 良好的基础；也便于教师批改与回复电子作 业。 ◼ 执行良好的编码规范可以使编写出来的程序 易于阅读、理解和管理。 2. 编码规范的定义 ◼ 编码 （coding）：是指用适当的代码编写工 具编写C语言程序的源代码 ◼ 编码规范： ◼ 相关英文说法：coding standard, coding convention, coding criterion ◼ 是指被普通采用的、或由某个企业或机构规定的， 用计算机语言编写程序的过程中需要遵守的一套 规则或约定的集合 ◼ 编码规范并不是语言的语 则 3. 编码规范的应用 ◼ 在软件业高速发展、团队开发成为基本开发 模式的今天，几乎每个软件企业或软件开发 团队都会制定各种各样的规范，应用于软件 开发过程的各个环节中，编码规范是最基础 规范之一。 ◼ 不同的公司，对同一种开发语言，一般都采 用类似的规范，也就是说编码规范具有一些 通用性的标准 4. 编码规范的学习和执行 ◼ 要求学习和掌握规范标准 ◼ 要求在本课程的作业过程中执行这些规范， 上交的电子作业必须符合这些规范要求 ◼ 要求在后续相关课程中执行此规范中的基本 部分，并根据后续课程内容要求执行相应的 扩展规范 第二部分C语言编码规范 Coding standards 1. 文件级模块说明规范 File module specification 文件级模块说明规范的含义 ◼ 模块定义:指以独立的文件形式存在的模块， 主要包括两类 ◼ C 的扩展名为.c或.cpp的源代码文件模块，例如 abc.cpp, exam.c ◼ 扩展名为.h的头文件模块, 如abc.h ，exam.h ◼ 对于任何一个用户新建的模块，必须按规范 要求给出模块的相关描述信息 文件级模块说明的构成 ◼ 文件级模块说明至少应由以下部分构成 ◼ 1. 模块的作者信息 ◼ 2. 模块的 ◼ 3. 模块的名称 ◼ 4. 模块的 描述 ◼ 5. 模块的其它说明 ◼ 6. 模块的历史信息 文件级模块说明的编写 ◼ 1. 每个用户的文件级代码模块必须编写一个 说明 ◼ 2. 模块说明要求以注释的形式出现在模块的 首部 ◼ 3. 为了减少每次的工作，每个人应先编写好 不变部分，每新建一个模块将不变部分 到文件首部，再行更改可变部分 中文版文件级模块说明规范 /****************************************************\ 作者信息： ： 学号： 班级： 学院： : ： ： 模块名