软件设计规范x.docxVIP

软件设计规范

为统一编程风格，提高代码可读性和易维护性，特制定本编程规范，请全体嵌入式开収同事此规范执行。

更新记录

日期

更新人

内容

2023-12-06

ALEN

初稿

目录

TOC\o1-3\h\u119711?文件结构 3

49461.1?文件信息声明 3

234841.2?头文件的结构 4

134171.3?定义文件的结构 5

61651.4?头文件的作用 6

229561.5?目录结构 6

281662?命名规则 6

22492.1?共性原则 7

182973?程序风格 7

233483.1?空行 7

313813.2?代码行 8

283923.3?代码行内的空格 9

133053.4?对齐 10

292743.5?长行拆分 11

295453.6?修饰符的位置 11

196703.7?注释 11

141323.7.1?文件头的注释 12

119904?函数设计 13

50374.1?参数的规则 13

292134.2?返回值的规则 14

80314.3?函数内部实现的规则 16

121844.4?其它建议 17

86744.5?使用断言 17

249144.6?引用与指针的比较 18

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,DepartmentofMathematics,?Zhejiang?University

//Allrightsreserved.

//

//Filename?????：filename.h

//ProjectCode?：Theprojectcodeaboutthisfile

//Abstract?????：Describethecontentofthisfilesummarily

//Reference????：

//

//Version??????：1.1

//Author???????：thenameofauthor(mender)

//Accomplisheddate?：?September2,2004

//

//Replacedversion??:??1.0

//OriginalAuthor???:?thenameoforiginalauthor(mender)

//Accomplisheddate:?September?10,2003

//

//Mainfunctions????：

//??Function1Returncode??????Functionname(ParameterExplain)

//??Function2Returncode??????Functionname(ParameterExplain)

//??...

//??FunctionnReturncode??????Functionname(ParameterExplain)

////////////////////////////////////////////////////////////////////////////

////////////////////////////////////////////////////////////////////////////

示例1-1?文件信息声明

☆???????【规则1.1-1】