《C编程规范.doc》由会员分享，可在线阅读，更多相关《C编程规范.doc（12页珍藏版）》请在taowenge.com淘文阁网|工程机械CAD图纸|机械工程制图|CAD装配图下载|SolidWorks_CaTia_CAD_UG_PROE_设计图分享下载上搜索。
1、/ 摘自高质量C+/C 编程指南第1 章 文件结构每个C+/C 程序通常分为两个文件。一个文件用于保存程序的声明（declaration），称为头文件。另一个文件用于保存程序的实现（implementation），称为定义（definition）文件。C+/C 程序的头文件以“.h”为后缀，C 程序的定义文件以“.c”为后缀，C+程序的定义文件通常以“.cpp”为后缀（也有一些系统以“.cc”或“.cxx”为后缀）。1.1 版权和版本的声明版权和版本的声明位于头文件和定义文件的开头（参见示例1-1），主要内容有：（1）版权信息。（2）文件名称，标识符，摘要。（3）当前版本号，作者/修改者，完成
2、日期。（4）版本历史信息。示例1-1 版权和版本的声明/* Copyright (c) 2001,上海贝尔有限公司网络应用事业部* All rights reserved.* 文件名称：filename.h* 文件标识：见配置管理计划书* 摘 要：简要描述本文件的内容* 当前版本：1.1* 作 者：输入作者（或修改者）名字* 完成日期：2001年7月20日* 取代版本：1.0* 原作者 ：输入原作者（或修改者）名字* 完成日期：2001年5月10日*/1.2 头文件的结构头文件由三部分内容组成：（1）头文件开头处的版权和版本声明（参见示例1-1）。（2）预处理块。（3）函数和类结构声明等。假设
3、头文件名称为 graphics.h，头文件的结构参见示例1-2。 【规则1-2-1】为了防止头文件被重复引用，应当用ifndef/define/endif 结构产生预处理块。 【规则1-2-2】用 #include 格式来引用标准库的头文件（编译器将从标准库目录开始搜索）。 【规则1-2-3】用 #include “filename.h” 格式来引用非标准库的头文件（编译器将从用户的工作目录开始搜索）。 【建议1-2-1】头文件中只存放“声明”而不存放“定义”在C+ 语法中，类的成员函数可以在声明的同时被定义，并且自动成为内联函数。这虽然会带来书写上的方便，但却造成了风格不一致，弊大于利。建议
4、将成员函数的定义与声明分开，不论该函数体有多么小。 【建议1-2-2】不提倡使用全局变量，尽量不要在头文件中出现象extern int value 这类声明。示例1-2 C+/C 头文件的结构#ifndef GRAPHICS_H / 防止graphics.h 被重复引用#define GRAPHICS_H#include / 引用标准库的头文件#include “myheader.h” / 引用非标准库的头文件void Function1(); / 全局函数声明class Box / 类结构声明;#endif1.3 定义文件的结构定义文件有三部分内容：（1） 定义文件开头处的版权和版本声明（参
5、见示例1-1）。（2） 对一些头文件的引用。（3） 程序的实现体（包括数据和代码）。假设定义文件的名称为 graphics.cpp，定义文件的结构参见示例1-3。/ 版权和版本声明见示例1-1，此处省略。#include “graphics.h” / 引用头文件/ 全局函数的实现体void Function1()/ 类成员函数的实现体void Box:Draw()示例1-3 C+/C 定义文件的结构1.4 头文件的作用早期的编程语言如Basic、Fortran 没有头文件的概念，C+/C 语言的初学者虽然会用使用头文件，但常常不明其理。这里对头文件的作用略作解释：（1）通过头文件来调用库功能。
6、在很多场合，源代码不便（或不准）向用户公布，只要向用户提供头文件和二进制的库即可。用户只需要按照头文件中的接口声明来调用库功能，而不必关心接口怎么实现的。编译器会从库中提取相应的代码。（2）头文件能加强类型安全检查。如果某个接口被实现或被使用时，其方式与头文件中的声明不一致，编译器就会指出错误，这一简单的规则能大大减轻程序员调试、改错的负担。1.5 目录结构如果一个软件的头文件数目比较多（如超过十个），通常应将头文件和定义文件分别保存于不同的目录，以便于维护。例如可将头文件保存于include 目录，将定义文件保存于source 目录（可以是多级目录）。如果某些头文件是私有的，它不会被用户的程
7、序直接引用，则没有必要公开其“声明”。为了加强信息隐藏，这些私有的头文件可以和定义文件存放于同一个目录。第2 章 程序的版式版式虽然不会影响程序的功能，但会影响可读性。程序的版式追求清晰、美观，是程序风格的重要构成因素。可以把程序的版式比喻为“书法”。好的“书法”可让人对程序一目了然，看得兴致勃勃。差的程序“书法”如螃蟹爬行，让人看得索然无味，更令维护者烦恼有加。请程序员们学习程序的“书法”，弥补大学计算机教育的漏洞，实在很有必要。2.1 空行空行起着分隔程序段落的作用。空行得体（不过多也不过少）将使程序的布局更加清晰。空行不会浪费内存，虽然打印含有空行的程序是会多消耗一些纸张，但是值得。所以
8、不要舍不得用空行。 【规则2-1-1】在每个类声明之后、每个函数定义结束之后都要加空行。参见示例2-1（a） 【规则2-1-2】在一个函数体内，逻揖上密切相关的语句之间不加空行，其它地方应加空行分隔。参见示例2-1（b ）/ 空行void Function1()/ 空行void Function2()/ 空行void Function3()/ 空行while (condition)statement1;/ 空行if (condition)statement2;elsestatement3;/ 空行statement4;示例2-1(a) 函数之间的空行 示例2-1(b) 函数内部的空行2.2 代
9、码行 【规则2-2-1】一行代码只做一件事情，如只定义一个变量，或只写一条语句。这样的代码容易阅读，并且方便于写注释。 【规则2-2-2】if、for、while、do 等语句自占一行，执行语句不得紧跟其后。不论执行语句有多少都要加。这样可以防止书写失误。示例2-2（a）为风格良好的代码行，示例2-2（b）为风格不良的代码行。int width; / 宽度int height; / 高度int depth; / 深度int width, height, depth; / 宽度高度深度x = a + b;y = c + d;z = e + f;X a + b; y = c + d; z = e
10、+ f;示例2-2(a) 风格良好的代码行 if (width height)dosomething();if (width =”、“=”、“+”、“*”、“%”、“&”、“|”、“”这类操作符前后不加空格。 【建议2-3-1】对于表达式比较长的for 语句和if 语句，为了紧凑起见可以适当地去掉一些空格，如示例2-3 代码行内的空格for (i=0; i10; i+)和if (a=b) & (c= 2000) / 良好的风格if(year=2000) / 不良的风格if ( ( a=b ) & (c =b&c=d) / 不良的风格for (i = 0; i 10; i+) / 良好的风格fo
11、r(i=0;i10;i+) / 不良的风格for (i = 0; I 10; i +) / 过多的空格x = a b ? a : b; / 良好的风格x=aFunction(); / 不要写成 b - Function();2.4 对齐 【规则2-4-1】程序的分界符和应独占一行并且位于同一列，同时与引用它们的语句左对齐。 【规则2-4-2】 之内的代码块在右边数格处左对齐。示例2-4（a）为风格良好的对齐void Function(int x) / program codeif (condition) / program codeelse / program codefor (initial
12、ization; condition; update) / program codeWhile (condition) / program code示例2-4（b）为风格不良的对齐。while (condition) / program codevoid Function(int x) / program codeif (condition) / program codeelse / program codefor (initialization; condition; update) / program code如果出现嵌套的，则使用缩进对齐，如：2.5 长行拆分 【规则2-5-1】代码行最
13、大长度宜控制在70 至80 个字符以内。代码行不要过长，否则眼睛看不过来，也不便于打印。 【规则2-5-2】长表达式要在低优先级操作符处拆分成新行，操作符放在新行之首（以便突出操作符）。拆分出的新行要进行适当的缩进，使排版整齐，语句可读。if (very_longer_variable1 = very_longer_variable12)& (very_longer_variable3 = very_longer_variable14)& (very_longer_variable5 Draw(); / 类的成员函数 【规则3-1-8】用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。
14、例如：int minValue;int maxValue;int SetValue();int GetValue();【建议3-1-1】尽量避免名字中出现数字编号，如Value1,Value2 等，除非逻辑上的确需要编号。这是为了防止程序员偷懒，不肯为命名动脑筋而导致产生无意义的名字（因为用数字编号最省事）。3.2 简单的Windows 应用程序命名规则作者对“匈牙利”命名规则做了合理的简化，下述的命名规则简单易用，比较适合于Windows 应用软件的开发。 【规则3-2-1】类名和函数名用大写字母开头的单词组合而成。例如：class Node; / 类名class LeafNode; / 类
15、名void Draw(void); / 函数名void SetValue(int value); / 函数名 【规则3-2-2】变量和参数用小写字母开头的单词组合而成。例如：BOOL flag;int drawMode; 【规则3-2-3】常量全用大写的字母，用下划线分割单词。例如：const int MAX = 100;const int MAX_LENGTH = 100; 【规则3-2-4】静态变量加前缀s_（表示static）。例如：void Init()static int s_initValue; / 静态变量【规则3-2-5】如果不得已需要全局变量，则使全局变量加前缀g_（表示gl
16、obal）。例如：int g_howManyPeople; / 全局变量int g_howMuchMoney; / 全局变量 【规则3-2-6】类的数据成员加前缀m_（表示member），这样可以避免数据成员与成员函数的参数同名。例如：void Object:SetValue(int width, int height)m_width = width;m_height = height;【规则3-2-7】为了防止某一软件库中的一些标识符和其它软件库中的冲突，可以为各种标识符加上能反映软件性质的前缀。例如三维图形标准OpenGL 的所有库函数均以gl 开头，所有常量（或宏定义）均以GL 开头。第
17、4 章 表达式和基本语句读者可能怀疑：连if、for、while、goto、switch 这样简单的东西也要探讨编程风格，是不是小题大做？我真的发觉很多程序员用隐含错误的方式写表达式和基本语句，我自己也犯过类似的错误。表达式和语句都属于C+/C 的短语结构语法。它们看似简单，但使用时隐患比较多。本章归纳了正确使用表达式和语句的一些规则与建议。4.2 复合表达式如 a = b = c = 0 这样的表达式称为复合表达式。允许复合表达式存在的理由是：（1）书写简洁；（2）可以提高编译效率。但要防止滥用复合表达式。 【规则4-2-1】不要编写太复杂的复合表达式。例如：i = a = b & c d & c + f = g + h ; / 复合表达式过于复杂 【规则4-2-2】不要有多用途的复合表达式。例如：d = (a = b + c) + r ;该表达式既求a 值又求d 值。应该拆分为两个独立的语句：a = b + c;d = a + r; 【规则4-2-3】不要把程序中的复合表达式与“真正的数学表达式”混淆。例如：if (a b c) / a b c 是数学表达式而不是程序表达式并不表示if (ab) & (bc)而是成了令人费解的if ( (ab)c )12