编码规范要点.docVIP

软件开发规范 在研究项目团队协作开发的情况下（这里的团队协作也适合于应用项目的开发），编程时应该强调的一个重要方面是程序的易读性，在保证软件速度等性能指标能满足用户需求的情况下，能让其他程序员容易读懂你所编写的程序。若研究项目小组的所有开发人员都遵循统一的、鲜明的一套编程风格，可以让协作者、后继者和自己一目了然，在很短的时间内看清楚程序结构，理解设计的思路，大大提高代码的可读性、可重用性、程序健壮性、可移植性、可维护性。 制定本编程规范的目的是为了提高软件开发效率及所开发软件的可维护性，提高软件的质量。本规范由程序风格、命名规范、注释规范、程序健壮性、可移植性、错误处理以及软件的模块化规范等部分组成。 本软件开发规范适合讨论C/C++程序设计。 1 文件结构 每个C++/C程序通常分为两个文件。一个文件用于保存程序的声明（declaration），称为头文件。另一个文件用于保存程序的实现（implementation），称为定义（definition）文件。 C++/C程序的头文件以“.h”为后缀，C程序的定义文件以“.c”为后缀，C++程序的定义文件通常以“.cpp”为后缀（也有一些系统以“.cc”或“.cxx”为后缀）。 1.1 文件信息声明 文件信息声明位于头文件和定义文件的开头（参见示例1-1），主要内容有： （1）?????? （2）?????? （3）?????? /修改者，完成日期； （4）?????? （5）?????? ? //////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////// // Copyright (c) 2004, Department of Mathematics, Zhejiang University // All rights reserved. // // Filename ：filename.h // Project Code ：The project code about this file // Abstract ：Describe the content of this file summarily // Reference ：...... // // Version ：1.1 // Author ：the name of author(mender) // Accomplished date ： September 2, 2004 // // Replaced version : 1.0 // Original Author : the name of original author(mender) // Accomplished date : September 10, 2003 // // Main functions ： // Function 1 Return code Function name(Parameter Explain) // Function 2 Return code Function name(Parameter Explain) // ... // Function n Return code Function name(Parameter Explain) //////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////// 示例1-1 文件信息声明 ☆?????? 【规则1.1-1】 文件信息声明以两行斜杠开始，以两行斜杠结束，每一行都以两个斜杠开始； ☆?????? 【规则1.1-2】 文件信息声明包含五个部分，各部分之间以一空行间隔； ☆??????? 【规则1.1-3】 在主要函数部分描述了文件所包含的主要函数的声明信息，如果是头文件，这一部分是可以省略的。 1.2 头文件的结构 头文件由三部分内容组成： (1)??? 头文件开头处的文件信息声明(参见示例1-1)； (2)??? 预处理块； (3)??? 函数和类结构声明等。 假设头文件名称为 filesystem.h，头文件的结构参见示例1-2。 ☆?????? 【规则1.2-1】 为了防止头文件被重复引用，应