|
程序开发规范 文件编号：SD-RD-开发规范-V1.0 序号： 项目名称： 第1节 文件结构.... 2 1.1 版权和版本的声明... 2 1.2 头文件（.h）的结构... 3 1.3 定义文件（.cpp）的结构... 4 1.4 目录结构... 5 第2节 程序的版式.... 6 2.1 空行... 6 2.2 代码行... 7 2.3 代码行内的空格... 8 2.4 对齐... 9 2.5 长行拆分... 11 2.6 注释... 12 2.7 类的版式... 13 第3章 命名规则.... 15 1. 简单变量... 15 2. 结构... 15 3. 类... 16 4. 类数据成员... 16 5. 静态变量... 16 6. 全局变量... 16
第1节 文件结构C++程序的头文件以“.h”为后缀，C++程序的定义文件以“.cpp”为后缀。 1.1 版权和版本的声明版权和版本的声明位于头文件和定义文件的开头（参见示例1-1），主要内容有： （1）版权信息。 （2）文件名称，标识符，摘要。 （3）当前版本号，作者/修改者，完成日期。 （4）版本历史信息。
| /* * Copyright (c) 2003,上海盛大网络研发中心 * All rights reserved. * * 文件名称：filename.h * 摘 要：简要描述本文件的内容 * * 当前版本：1.1 * 作 者：输入作者（或修改者）名字 * 完成日期：2003年x月xx日 * * 取代版本：1.0 * 原作者 ：输入原作者（或修改者）名字 * 完成日期：2003年x月xx日 */
|
示例1-1 版权和版本的声明 1.2 头文件（.h）的结构头文件由三部分内容组成： （1）头文件开头处的版权和版本声明（参见示例1-1）。 （2）预处理块。 （3）函数和类结构声明等。 假设头文件名称为graphics.h，头文件的结构参见示例1-2。
l 【规则1-2-1】为了防止头文件被重复引用，应当用#ifndef/#define/#endif结构产生预处理块。 l 【规则1-2-2】用 #include <filename.h>格式来引用标准库的头文件（编译器将从标准库目录开始搜索）。 l 【规则1-2-3】用 #include “filename.h”格式来引用非标准库的头文件（编译器将从用户的工作目录开始搜索）。 l 【规则1-2-4】头文件中只存放“声明”而不存放“定义”，除非需要定义的函数是内联函数。
| // 版权和版本声明见示例1-1，此处省略。
#ifndef GRAPHICS_H // 防止graphics.h被重复引用 #define GRAPHICS_H
#include <math.h> // 引用标准库的头文件 … #include “myheader.h” // 引用非标准库的头文件 … void Function1(…); // 全局函数声明 … class CBox // 类结构声明 { … }; #endif |
示例1-2 C++/C头文件的结构
1.3 定义文件（.cpp）的结构定义文件有三部分内容： （1） 定义文件开头处的版权和版本声明（参见示例1-1）。 （2） 对一些头文件的引用。 （3） 程序的实现体（包括数据和代码）。 假设定义文件的名称为graphics.cpp，定义文件的结构参见示例1-3。
| // 版权和版本声明见示例1-1，此处省略。
#include “graphics.h” // 引用头文件 … // 全局函数的实现体 void Function1(…) { … }
// 类成员函数的实现体 void CBox:  raw(…) { … } |
示例1-3 C++/C定义文件的结构 1.4目录结构如果一个软件的头文件数目比较多（如超过十个），通常应将头文件和定义文件分别保存于不同的目录，以便于维护。 例如可将头文件保存于include目录，将定义文件保存于source目录（可以是多级目录）。
第2节 程序的版式
2.1空行l 【规则2-1-1】在每个类声明之后、每个函数定义结束之后都要加空行。参见示例2-1（a） l 【规则2-1-2】在一个函数体内，逻揖上密切相关的语句之间不加空行，其它地方应加空行分隔。参见示例2-1（b ）
| // 空行 void Function1(…) { … } // 空行 void Function2(…) { … } // 空行 void Function3(…) { … }
| // 空行 while (condition) { statement1; // 空行 if (condition) { statement2; } else { statement3; } // 空行 statement4; } |
示例2-1(a) 函数之间的空行 示例2-1(b) 函数内部的空行
2.2代码行l 【规则2-2-1】一行代码只做一件事情，如定义变量，或只写一条语句。这样的代码容易阅读，并且方便于写注释。 l 【规则2-2-2】if、for、while、do等语句自占一行，执行语句不得紧跟其后。不论执行语句有多少都要加{}。这样可以防止书写失误。
示例2-2（a）为风格良好的代码行，示例2-2（b）为风格不良的代码行。
| x = a + b; y = c + d; z = e + f; | X ＝ a + b; y = c + d; z = e + f;
| | if (width < height) { dosomething(); } | if (width < height) dosomething(); | | For (initialization; condition; update) { dosomething(); } // 空行 other();
| for (initialization; condition; update) dosomething(); other();
|
示例2-2(a) 风格良好的代码行 示例2-2(b)风格不良的代码行
² 【建议2-2-1】尽可能在定义变量的同时初始化该变量（就近原则） 如果变量的引用处和其定义处相隔比较远，变量的初始化很容易被忘记。如果引用了未被初始化的变量，可能会导致程序错误。本建议可以减少隐患。例如 int iWidth = 10; // 定义并初绐化width int iHeight = 10; // 定义并初绐化height int iDepth = 10; // 定义并初绐化depth
2.3代码行内的空格l 【规则2-3-1】关键字之后要留空格。象const、virtual、inline、case 等关键字之后至少要留一个空格，否则无法辨析关键字。象if、for、while等关键字之后应留一个空格再跟左括号‘（’，以突出关键字。 l 【规则2-3-2】函数名之后不要留空格，紧跟左括号‘（’，以与关键字区别。 l 【规则2-3-3】‘（’向后紧跟，‘）’、‘，’、‘;’向前紧跟，紧跟处不留空格。 l 【规则2-3-4】‘，’之后要留空格，如Function(x, y, z)。如果‘;’不是一行的结束符号，其后要留空格，如for (initialization; condition; update)。 l 【规则2-3-5】赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符，如“=”、“+=” “>=”、“<=”、“+”、“*”、“%”、“&&”、“||”、“<<”,“^”等二元操作符的前后应当加空格。 l 【规则2-3-6】一元操作符如“!”、“~”、“++”、“--”、“&”（地址运算符）等前后不加空格。 l 【规则2-3-7】象“［］”、“.”、“->”这类操作符前后不加空格。 ² 【建议2-3-1】对于表达式比较长的for语句和if语句，为了紧凑起见可以适当地去掉一些空格，如for (i=0; i<10; i++)和if ((a<=b) && (c<=d))
| void Func1(int x, int y, int z); // 良好的风格 void Func1 (int x,int y,int z); // 不良的风格 | | if (year >= 2000) // 良好的风格 if(year>=2000) // 不良的风格 if ((a>=b) && (c<=d)) // 良好的风格 if(a>=b&&c<=d) // 不良的风格 | | for (i=0; i<10; i++) // 良好的风格 for(i=0;i<10;i++) // 不良的风格 for (i = 0; i < 10; i ++) // 过多的空格 | | x = a < b ? a : b; // 良好的风格 x=a<b?a:b; // 不好的风格 | | int *x = &y; // 良好的风格 int * x = & y; // 不良的风格 | | array[5] = 0; // 不要写成 array [ 5 ] = 0; a.Function(); // 不要写成 a . Function(); b->Function(); // 不要写成 b -> Function();
|
示例2-3 代码行内的空格
2.4对齐l 【规则2-4-1】程序的分界符‘{’和‘}’应独占一行并且位于同一列，同时与引用它们的语句左对齐。 l 【规则2-4-2】{ }之内的代码块在‘{’右边数格处左对齐。
示例2-4（a）为风格良好的对齐，示例2-4（b）为风格不良的对齐。
void Function(int x) { … // program code } |
void Function(int x){ … // program code }
| | if (condition) { … // program code } else { … // program code } | if (condition){ … // program code } else { … // program code } | | for (initialization; condition; update) { … // program code } | for (initialization; condition; update){ … // program code } | | While (condition) { … // program code } | while (condition){ … // program code } | | 如果出现嵌套的｛｝，则使用缩进对齐，如： { … { … } … } |
|
示例2-4(a) 风格良好的对齐 示例2-4(b) 风格不良的对齐
2.5长行拆分l 【规则2-5-1】代码行最大长度宜控制在70至80个字符以内。代码行不要过长，否则不便于阅读。 l 【规则2-5-2】长表达式要在低优先级操作符处拆分成新行，操作符放在新行之首（以便突出操作符）。拆分出的新行要进行适当的缩进，使排版整齐，语句可读。
| if ((very_longer_variable1 >= very_longer_variable12) && (very_longer_variable3 <= very_longer_variable14) && (very_longer_variable5 <= very_longer_variable16)) { dosomething(); } | | virtual CMatrix CMultiplyMatrix (CMatrix leftMatrix, CMatrix rightMatrix);
| | for (very_longer_initialization; very_longer_condition; very_longer_update) { dosomething(); } |
示例2-5 长行的拆分 2.6注释C++语言中，程序块的注释常采用“/*…*/”，行注释一般采用“//…”。注释通常用于： （1）版本、版权声明； （2）函数接口说明； （3）重要的代码行或段落提示。 虽然注释有助于理解代码，但注意不可过多地使用注释。参见示例2-6。
l 【规则2-6-1】注释是对代码的“提示”，而不是文档。程序中的注释不可喧宾夺主，注释太多了会让人眼花缭乱。注释的花样要少。 l 【规则2-6-2】如果代码本来就是清楚的，则不必加注释。否则多此一举，令人厌烦。例如 i++; //i 加 1，多余的注释 l 【规则2-6-3】边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。 l 【规则2-6-4】注释应当准确、易懂，防止注释有二义性。错误的注释不但无益反而有害。 l 【规则2-6-5】尽量避免在注释中使用缩写，特别是不常用缩写。 l 【规则2-6-6】注释的位置应与被描述的代码相邻，可以放在代码的上方或右方，不可放在下方。 l 【规则2-6-8】当代码比较长，特别是有多重嵌套时，应当在一些段落的结束处加注释，便于阅读。
/* * 函数介绍： * 输入参数： * 输出参数： * 返回值 ： */ void Function(float x, float y, float z) { … } |
if (…) { … while (…) { … } // end of while … } // end of if |
|
|
示例2-6程序的注释
2.7类的版式类可以将数据和函数封装在一起，其中函数表示了类的行为（或称服务）。类提供关键字public、protected和private，分别用于声明哪些数据和函数是公有的、受保护的或者是私有的。这样可以达到信息隐藏的目的，即让类仅仅公开必须要让外界知道的内容，而隐藏其它一切内容。我们不可以滥用类的封装功能，不要把它当成火锅，什么东西都往里扔。 类的版式需要按以下方式设计： （2）将public类型的成员写在前面，而将private类型的成员写在后面。将public类型的成员函数和成员变量分段排布，并且将public类型的成员函数 放在最前面。参见示例2-7。 | class CTest { public: void Func1(void); void Func2(void); … public: int m_iHeight;
private: float m_fLen; … } |
示例2-7
第3章 命名规则命名规则一般采用“匈牙利命名”法。 1. 简单变量简单变量的命名方法：Prefix＋XXXXXX： [td] | | | | b | | | by | | | c | | | dw | | | e | | | f | | | h | | | n | | | l | | | P | | | Sz | | | W | |
2. 结构结构名称必须全用大写，例如 typedef struct { } USER,* PUSER;
3. 类类的名称必须用C打头例如 class CBox { …… } 4. 类数据成员规则：m_XXXX 5. 静态变量静态变量加前缀s_（表示static）。 例如： void Init(…) { static int s_iInitValue; // 静态变量 … } 6. 全局变量如果不得已需要全局变量，则使全局变量加前缀g_（表示global）。 例如： int g_iHowManyPeople; // 全局变量 int g_iHowMuchMoney; // 全局变量
| 
发表于 2024-2-26 12:57:11
扫码关注微信公众号，及时获取最新资源信息！【