软件编程规范

电玩女神 2023-02-23 12:13 88阅读 0赞

1 排版  
1-1：程序块要采用缩进风格编写，缩进的空格数为4个。（规定）  
说明：对于由开发工具自动生成的代码可以有不一致。  
1-2：不允许把多个短语句写在一行中，即一行只写一条语句。（强烈建议）  
示例：如下例子不符合规范。  
rect.length = 0; rect.width = 0;  
应如下书写  
rect.length = 0;  
rect.width = 0;  
注：nop()函数可以一行写多个，但最多不要超过5个。

1-3：if、for、do、while、case、switch、default等语句自占一行，且if、for、do、while等语句的执行语句部分无论多少都要加括号\{\}。示例：如下例子不符合规范。（规定）  
if (pUserCR == NULL) return;  
应如下书写：  
if (pUserCR == NULL)  
\{  
return;  
\}

1-4：在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加空格；进行非对等操作时，如果是关系密切的立即操作符（如－>），后不应加空格。（规定）  
说明：采用这种松散方式编写代码的目的是使代码更加清晰。由于留空格所产生的清晰性是相对的，所以，在已经非常清晰的语句中没有必要再留空格，如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格，多重括号间不必加空格。  
在长语句中，如果需要加的空格非常多，那么应该保持整体清晰，而在局部不加空格。给操作符留空格时不要连续留两个以上空格。  
示例：  
(1) 逗号、分号只在后面加空格。  
int a, b, c;  
(2)比较操作符, 赋值操作符"="、 “+=”，算术操作符"+"、"%"，逻辑操作符"&&"、"&"，位域操作符"<<"、"^“等双目操作符的前后加空格。  
if (current\_time>= MAX\_TIME\_VALUE)  
a = b + c;  
a \*= 2;  
a = b ^ 2;  
(3)”!"、"~"、"++"、"–"、"&"（地址运算符）等单目操作符前后不加空格。  
*p = ‘a’; // 内容操作"*“与内容之间  
flag = !isEmpty; // 非操作”!“与内容之间  
p = &mem; // 地址操作”&" 与内容之间  
i++; // “++”,"–“与内容之间  
(4)”->"、"."前后不加空格。  
p->id = pid; // "->"指针前后不加空格  
(5) if、for、while、switch等与后面的括号间应加空格，使if等关键字更为突出、明显。  
if (a >= b && c > d)

2 注释

2-1：一般情况下，源程序有效注释量必须在20％以上。  
说明：注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。

2-2：说明性文件（如头文件.h文件、说明文件.txt等）头部应进行注释，注释必须列出：版权说明、版本号、生成日期、作者、内容、功能、接口、与其它文件的关系、修改日志等，头文件的注释中还应有函数功能简要说明。（规定）  
示例：下面这段头文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。  
/\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*  
Copyright ©, 2010-2030, Risecomm Micro. Co., Ltd.  
File name: // 文件名  
Author: Version: Date: // 作者、版本及完成日期  
Description: // 用于详细说明此程序文件完成的主要功能，与其他模块  
// 或函数的接口，输出值、取值范围、含义及参数间的控  
// 制、顺序、独立或依赖等关系  
Others: // 其它内容的说明  
History: // 修改历史记录列表，每条修改记录应包括修改日期、修改  
// 者及修改内容简述  
…………  
\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*/

/\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*  
Copyright ©, 2010-2030, Risecomm Micro. Co., Ltd.  
Filename: xxxxx.h  
Author: Version: Date:  
Description:  
Others:  
History:  
\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*/  
\#ifndef XXXXX\_H  
\#define XXXXX\_H  
/*-----------------------------------------------------------------------------------------------------  
Section: 头文件  
\-----------------------------------------------------------------------------------------------------*/

/*-----------------------------------------------------------------------------------------------------  
Section: 常数定义  
\-----------------------------------------------------------------------------------------------------*/

/*-----------------------------------------------------------------------------------------------------  
Section: 宏定义  
\-----------------------------------------------------------------------------------------------------*/

/*-----------------------------------------------------------------------------------------------------  
Section: 类型定义  
\-----------------------------------------------------------------------------------------------------*/

/*-----------------------------------------------------------------------------------------------------  
Section: 外部函数原型  
\-----------------------------------------------------------------------------------------------------*/

/*-----------------------------------------------------------------------------------------------------  
Section: 函数原型  
\-----------------------------------------------------------------------------------------------------*/

\#endif

2-3：源文件头部应进行注释，列出：版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。（规定）  
/\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*  
Copyright ©, 2010-2030, Risecomm Micro. Co., Ltd.  
FileName: test.cpp  
Author: Version : Date:  
Description: // 用于详细说明此程序文件完成的主要功能，与其他模块  
// 或函数的接口，输出值、取值范围、含义及参数间的控  
// 制、顺序、独立或依赖等关系  
Others: // 其它内容的说明  
History: // 历史修改记录  
…………  
\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*/  
说明：Description一项描述本文件的内容、功能、内部各部分之间的关系及本文件与其它文件关系等。History是修改历史记录列表，每条修改记录应包括修改日期、修改者及修改内容简述。

/\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*  
Copyright ©, 2010-2030, Risecomm Micro. Co., Ltd.  
FileName: xxxxx.c  
Author: Version : Date:  
Description:  
Others:  
History:  
\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\**/  
/\-----------------------------------------------------------------------------------------------------  
Section: 头文件  
\-----------------------------------------------------------------------------------------------------*/

/*-----------------------------------------------------------------------------------------------------  
Section: 外部变量  
\-----------------------------------------------------------------------------------------------------*/

/*----------------------------------------------------------------------------------------------------  
Section: 常数定义  
\-----------------------------------------------------------------------------------------------------*/

/*-----------------------------------------------------------------------------------------------------  
Section: 全局变量  
\-----------------------------------------------------------------------------------------------------*/

/*-----------------------------------------------------------------------------------------------------  
Section: 本地变量  
\-----------------------------------------------------------------------------------------------------*/

/\*-----------------------------------------------------------------------------------------------------  
Section: 本地函数原型

\---------------------------------------------------------------------------------------------------------\*/

2-4：函数头部应进行注释，列出：函数的目的/功能、输入参数、输出参数、返回值、调用关系（函数、表）等。（规定）  
示例：下面这段函数的注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。  
/\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*  
Function: // 函数名称  
Description: // 函数功能、性能等的描述  
Input: // 输入参数说明，包括每个参数的作  
// 用、取值说明及参数间关系。  
Output: // 对输出参数的说明。  
Return: // 函数返回值的说明  
Others: // 其它说明  
\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*/

3 标识符命名

3-1：对于变量命名，禁止取单个字符（如i、j、k…），建议除了要有具体含义外，还能表明其变量类型、数据类型等，但i、j、k作局部循环变量是允许的。（规范）  
说明：变量，尤其是局部变量，如果用单个字符表示，很容易敲错（如i写成j），而编译时又检查不出来，有可能为了这个小小的错误而花费大量的查错时间。  
示例：下面所示的局部变量名的定义方法可以借鉴。  
其变量名解释如下：  
intlvi\_Width  
其变量名解释如下：  
l 局部变量（Local）（其它：g 全局变量（Global），s静态变量（static） …）  
v 变量（Variable）（其它：c 常量（Const），p(指针)，a(数组), s(结构)，u(联合)，e(枚举) …）  
i 数据类型（Interger）（其它：u（无符号数），i(整型数)，b(位操作数)，l(长整形数)…）  
Width 变量含义  
即： 变量名=存储类 + 变量类型 + 数据类型 + 变量的英文意思（或缩写）  
这样可以防止局部变量与全局变量重名。

3-2：宏和常量命名（规定）  
宏和常量用全部大写字母来命名，词与词之间用下划线分隔。对程序中用到的数字均应用有意义的枚举或宏来代替。

3-3：对枚举类型（enum）中的变量，要求用枚举变量或其缩写做前缀。并且要求用大写。，此外要求枚举成员名的第一个单词相同;  
如：enumEMDAYS  
\{  
EMDAYS\_MONDAY;  
EMDAYS\_TUESDAY;  
……  
\};  
4变量、结构

4-1：当向公共变量传递数据时，要十分小心，防止赋与不合理的值或越界等现象发生。（建议）  
说明：对公共变量赋值时，若有必要应进行合法性检查，以提高代码的可靠性、稳定性。

4-2：严禁使用未经初始化的变量作为右值。（规定）  
说明：特别是在C/C++中引用未经赋值的指针，经常会引起系统崩溃。

4-3：编程时，要注意数据类型的强制转换。（规范）  
说明：当进行数据类型强制转换时，其数据的意义、转换后的取值等都有可能发生变化，而这些细节若考虑不周，就很有可能留下隐患。

4-4：对编译系统默认的数据类型转换，也要有充分的认识。（建议）  
示例：如下赋值，多数编译器不产生告警，但值的含义还是稍有变化。  
charchr;  
unsigned short int exam;  
chr = -1;  
exam = chr; // 编译器不产生告警，此时exam为0xFFFF。  
4-5：尽量减少没有必要的数据类型默认转换与强制转换。（建议）

4-6：合理地设计数据并使用自定义数据类型，避免数据间进行不必要的类型转换。（建议）

4-7：当声明用于分布式环境或不同CPU间通信环境的数据结构时，必须考虑机器的字节顺序、使用的位域及字节对齐等问题。（建议）

5函数

5-1：尽量避免使用可重入函数。（规范）  
5-2：若编写可重入函数时，若使用全局变量，则应通过关中断、信号量（即P、V操作）等手段对其加以保护。（建议）  
说明：若对所使用的全局变量不加以保护，则此函数就不具有可重入性，即当多个进程调用此函数时，很有可能使有关全局变量变为不可知状态。  
示例：假设Exam是int型全局变量，函数Squre\_Exam返回Exam平方值。那么如下函数不具有可重入性。  
unsignedint example( intpara )  
\{  
unsignedint temp;  
Exam = para; // （**）  
temp = Square\_Exam( );  
return temp;  
\}  
此函数若被多个进程调用的话，其结果可能是未知的，因为当（**）语句刚执行完后，另外一个使用本函数的进程可能正好被激活，那么当新激活的进程执行到此函数时，将使Exam赋与另一个不同的para值，所以当控制重新回到“temp = Square\_Exam( )”后，计算出的temp很可能不是预想中的结果。此函数应如下改进。  
unsignedint example( intpara )  
\{  
unsignedint temp;  
\[申请信号量操作\] // 若申请不到“信号量”，说明另外的进程正处于  
Exam = para; // 给Exam赋值并计算其平方过程中（即正在使用此  
temp = Square\_Exam( ); // 信号，本进程必须等待其释放信号后，才可继  
\[释放信号量操作\]  
// 续执行。若申请到信号，则可继续执行，但其  
// 它进程必须等待本进程释放信号量后，才能再使  
// 用本信号。  
return temp;  
\}

5-3：在同一项目组应明确规定对接口函数参数的合法性检查应由函数的调用者负责还是由接口函数本身负责，缺省是由函数调用者负责。（规范）  
说明：对于模块间接口函数的参数的合法性检查这一问题，往往有两个极端现象，即：要么是调用者和被调用者对参数均不作合法性检查，结果就遗漏了合法性检查这一必要的处理过程，造成问题隐患；要么就是调用者和被调用者均对参数进行合法性检查，这种情况虽不会造成问题，但产生了冗余代码，降低了效率。

5-4：防止将函数的参数作为工作变量。（规定）  
说明：将函数的参数作为工作变量，有可能错误地改变参数内容，所以很危险。对必须改变的参数，最好先用局部变量代之，最后再将该局部变量的内容赋给该参数。  
示例：下函数的实现不太好。  
voidsum\_data( unsigned intnum, int \*data, int \*sum )  
\{  
unsignedint count;  
\*sum = 0;  
for (count = 0; count <num; count++)  
\{  
\*sum += data\[count\]; // sum成了工作变量，不太好。  
\}  
\}  
若改为如下，则更好些。  
voidsum\_data( unsigned intnum, int \*data, int \*sum )  
\{  
unsignedint count ;  
Intsum\_temp;  
sum\_temp = 0;  
for (count = 0; count <num; count ++)  
\{  
sum\_temp += data\[count\];  
\}  
\*sum = sum\_temp;  
\}

5-5：函数的规模尽量限制在200行以内。（规定）  
说明：不包括注释和空格行。

5-6：一个函数仅完成一件功能。（建议）

5-7：避免设计多参数函数，不使用的参数从接口中去掉，最好能将参数控制在5个以内。（规范）  
说明：目的减少函数间接口的复杂度。

5-8：使用动宾词组为执行某操作的函数命名。如果是OOP方法，可以只有动词（名词是对象本身）。（建议）  
示例：参照如下方式命名函数。  
voidprint\_record( unsigned intrec\_ind ) ;  
intinput\_record( void ) ;  
unsigned char get\_current\_color( void ) ;

6质量保证  
6-1：只引用属于自己的存贮空间。（建议）  
说明：若模块封装的较好，那么一般不会发生非法引用他人的空间。

6-2：不要使用存储空间自动分配函数和释放函数。（规定）

6-3：时刻注意表达式是否会上溢、下溢。（规定）

6-4：防止内存操作越界。说明：内存操作主要是指对数组、指针、内存地址等的操作。内存操作越界是软件系统主要错误之一，后果往往非常严重，所以当我们进行这些操作时一定要仔细小心。使用变量时要注意其边界值的情况。（规定）

6-5：认真处理程序所能遇到的各种出错情况。（规定）

6-6：系统运行之初，要初始化有关变量及运行环境，防止未经初始化的变量被引用。（规定）

6-7：严禁随意更改其它模块或系统的有关设置和配置。说明：编程时，不能随心所欲地更改不属于自己模块的有关设置如常量、数组的大小等。（规定）

6-8：不能随意改变与其它模块的接口。（规定）

6-9：编程时，要防止差1错误。说明：此类错误一般是由于把“<=”误写成“<”或“>=”误写成“>”等造成的，由此引起的后果，很多情况下是很严重的，所以编程时，一定要在这些地方小心。当编完程序后，应对这些操作符进行彻底检查。（规定）

6-10：要时刻注意易混淆的操作符。当编完程序后，应从头至尾检查一遍这些操作符，以防止拼写错误。（规定）  
说明：形式相近的操作符最容易引起误用，如C/C++中的“=”与“==”、“|”与“||”、“&”与“&&”等，若拼写错了，编译器不一定能够检查出来。  
示例：如把“&”写成“&&”，或反之。  
ret\_flg = (pmsg->ret\_flg& RETURN\_MASK);  
被写为：  
ret\_flg = (pmsg->ret\_flg&& RETURN\_MASK);  
rpt\_flg = (VALID\_TASK\_NO( taskno ) && DATA\_NOT\_ZERO( stat\_data ));  
被写为：  
rpt\_flg = (VALID\_TASK\_NO( taskno ) & DATA\_NOT\_ZERO( stat\_data ));  
6-11：有可能的话，if语句尽量加上else分支，对没有else分支的语句要小心对待；switch语句必须有default分支。（规定）

6-12：减少没必要使用的指针，特别是比较复杂的指针。如指针的指针、数组的指针、指针的数组、函数指针等。（规定）  
用指针虽然灵活，但是也对程序的稳定性造成一定的威胁。安全的使用指针也不是一件容易的事情。

6-13：系统应具有一定的容错能力，对一些错误事件（如用户误操作等）能进行自动补救。（规定）