底层软件设计规范

《底层软件设计规范》由会员上传分享，免费在线阅读，更多相关内容在工程资料-天天文库。

1、底层软件设计规范第1章文件结构每个C程序通常分为两个文件。一个文件用于保存程序的声明，称为头文件。另一个文件用于保存程序的实现，称为定义文件。C程序的头文件以二2为后缀，C程序的定义文件以为后缀。1.1版权和版本的声明版权和版本的声明位于头文件和定义文件的开头，主要内容有：（1）版权信息。（2）文件名称，标识符，摘要。（3）当前版本号，作者/修改者，完成日期。（4）版本历史信息。/**Copyright（c）2010,成都中天鼎盛科技有限公司*Allrightsreserved.**文件名称：filename.h*文件标识：见配置管理计划书*摘要：简要描述

2、木文件的内容**当前版本：1」*作者：输入作者（或修改者）名字*完成日期：2010年2月8日**取代版本:1.0*原作者:输入原作者（或修改者）名字*完成日期：2010年2月9日引1.2头文件的结构头文件由三部分内容组成：（1）头文件开头处的版权和版木声明。（2）预处理块。（3）函数和类结构声明等。【规则1-2-1］为了防止头文件被重复引用，应当用ifndef/define/endif结构产牛预处理块。【规则1-2-2］用#include格式来引用标准库的头文件（编译器将从标准库目录开始搜索）。【规则1-2-3］用#include“

3、打lename.h”格式来引用非标准库的头文件（编译器将从用户的工作目录开始搜索）。【建议1-2-1］头文件中只存放“声明”而不存放“定义”。建议将成员函数的定义与声明分开，不论该函数体有多么小。【建议122】不提倡使用全局变量，尽量不要在头文件中出现象externintvalue这类声明。//版权和版本声明见示例1・1,此处省略。#ifndefGRAPHICS_H//防止graphics.h被重复引用#defineGRAPHICS_H#include//引用标准库的头文件•••#include"myheader.h"//引用非标准库的头文

4、件voidFunctionl（-）；H全局函数声明•••classBox//类结构声明{…};#endif1.3定义文件的结构定义文件有三部分内容：（1）定义文件开头处的版权和版本声明。（2）对一些头文件的引用。（3）程序的实现体（包括数据和代码）。//版权和版本声明#include"graphics.h"//引用头文件•••//全局函数的实现体voidFunction1（-）{••・}//类成员函数的实现体voidBox::Draw（）{•••}第2章程序的版式2.1空行空行起着分隔程序段落的作用。空行得体（不过多也不过少）将使程序的布局更加清晰。空行不

5、会浪费内存，虽然打印含有空行的程序是会多消耗一些纸张，但是值得。所以不要舍不得用空行。【规则2-1-1］在每个类声明Z后、每个函数定义结束Z后都要加空行。【规则2-1-2］在一个函数体内，逻揖上密切相关的语句之间不加空行，其它地方应加空行分隔。1、函数Z间的空行//空行voidFunction1（-）//空行voidFunction2(•)}//空行voidFunction3(•){•••}//空行2、函数内部的空行while(condition){statement1;//空行if(condition){statement2;}else{statemen

6、t3;}//空行statement4;}2.2代码行【规则2-2-1]一行代码只做一件事情，如只定义一个变量，或只写一条语句。这样的代码容易阅读，并且方便于写注释。【规则2-2-2]if、for、while,do等语句自占一行，执行语句不得紧跟其后。不论执行语句有多少都要加{}。这样可以防止书写失误。【建议2-2-1]尽可能在定义变量的同时初始化该变量(就近原则)如果变量的引用处和其定义处相隔比较远，变量的初始化很容易被忘记。如果引用了未被初始化的变量，可能会导致程序错误。本建议可以减少隐患。例如intwidth=10;//定义并初绐化widthinthe

7、ight=10;//定义并初绐化heightintdepth=10;//定义并初绐化depth:2.3代码行内的空格【规则2-3-1]关键字之后要留空格。象const>virtual>inline>case等关键字之后至少要留一个空格，否则无法辨析关键字。象讦、for、while等关键字之后应留一个空格再跟左括号'('，以突出关键字。【规则2-3-2】函数名之后不要留空格，紧跟左括号'('，以与关键字区别。【规则2-3-3】'('向后紧跟，‘)'、'，'、向前紧跟，紧跟处不留空格。【规则2-3-4]之后要留空格,如Fimction(x,y,z)。如果不是一

8、行的结束符号,其后要留空格,如for(initialization