NikkanNews规范_cn解说.doc

C++开发编程规范 作成 张能斌 审核 日付 Ver 内容 担当 2002/3/15 V1.00 参考《高质量C++编程指南》、《FIT编程规范》。 张能斌 2002/3/20 V1.01 补充部分内存管理内容。 胡进 C++开发编程规范 1 一、目的 4 二、软件评价 4 三、书写规范 4 3.1. 文件结构 4 3.1.1. 头文件的结构 4 3.1.2. 定义文件的结构 5 3.2. 程序版式 6 3.2.1. 空行 6 3.2.2. 代码行 7 3.2.3. 代码行内的空格 7 3.2.4. 对齐和缩进 8 3.2.5. 长行拆分 8 3.2.6. 修饰符的位置 9 3.2.7. 注释 9 3.2.8. 类的版式 10 3.3. 命名规则 11 3.3.1. 一般命名规则 11 3.3.2. 变量和常量命名 11 3.3.3. 类和函数的命名 12 3.3.4. ID的命名 12 四、 开发规范 13 4.1. 常量的使用 13 4.1.1. const 与 #define 13 4.1.2. 常量定义规则 13 4.1.3. 类中的常量 13 4.2. 变量的使用 14 4.3. 表达式和语句 16 4.3.1. 表达式中的运算符优先级 16 4.3.2. 复合表达式 16 4.3.3. if 语句 17 4.3.4. switch语句 18 4.3.5. goto语句 19 4.4. 函数设计 19 4.4.1. 参数的规则 20 4.4.2. 返回值的规则 21 4.4.3. 函数内部实现的规则 23 4.4.4. 有关构造函数、析构函数和赋值函数的使用 25 4.4.5. Serialize函数 25 4.5. 内存管理 27 4.6. 其它说明 28 4.6.1. 使用const提高函数的健壮性 28 4.6.2. 提高程序的效率 28 4.6.3. 一些有益的建议 29 一、目的 培养程序员良好的编写程序习惯，提高程序代码的安全性和可维护性。 软件评价 稳定可靠 动不动就死机是不行的！ 2、功能齐备 目标：满足用户的功能需求 手段：实现用户的所有功能 3、易学易用： 目标： 用户稍加培训就可操作,并可以自己进一步摸索 手段：充分利用面向对象的思想、软件的文档齐全 4、界面漂亮 目标：美观、亲切 手段： — 充分利用开发环境提供的能力 — 界面设计风格要统一化 5、好的软件 经过周密计划 经过审慎设计 有着完美的内部结构和让人赏心悦目的精美外观。 三、书写规范 好的书写规范，有助于提高程序的可读性，减少程序中的错误，便于大型软件的协作开发和维护。所以，请各位务必在编程过程中遵循以下的书写规范。 文件结构 头文件的结构 1、头文件组成 头文件开头处的版权和版本声明。 版权和版本的声明位于头文件和定义文件的开头，主要内容有： 版权信息。 文件名称，标识符，摘要。 当前版本号，作者/修改者，完成日期。 版本历史信息。 示例： /* * Copyright (c) 2001，北京方正国际软件系统有限公司 * All rights reserved. * * 文件名称：filename.h * 文件标识：见配置管理计划书 * 摘 要：简要描述本文件的内容 * * 当前版本：1.1 * 作 者：输入作者（或修改者）名字 * 完成日期：2001年7月20日 * * 取代版本：1.0 * 原作者 ：输入原作者（或修改者）名字 * 完成日期：2001年5月10日 */ 示例3-1 版权和版本的声明 （2）预处理块。 （3）函数和类结构声明等。 2、规则 为了防止头文件被重复引用，应当用ifndef/define/endif结构产生预处理块。 用 #include filename.h 格式来引用标准库的头文件（编译器将从标准库目录开始搜索）；用 #include “filename.h” 格式来引用非标准库的头文件（编译器将从用户的工作目录开始搜索）。 头文件中只存放“声明”而不存放“定义”。将成员函数的定义与声明分开，不论该函数体有多么小。 定义文件的结构 1、 定义文件开头处的版权和版本声明（参见示例3-1）。 对一些头文件的引用。 程序的实现体（包括数据和代码）。 首先定义全局函数的实现体，然后定义类成员函数的实现体。各个部分采用注释，空行等形式隔开。 假设定义文件的名称为 graphics.cpp，定义文件的结构参见示例3-2。 示例： // 版权和版本声明见示例1-1，此处省略。 #include “graphics.h” // 引用头文件 … // 全局函数的实现体 void Function1(…) { … } // 类成员函数的实现体 void Box::D