软件编程规范

只看该作者 · 2016-3-25 22:10

说下自己的一般原则

只看该作者 · 2016-3-25 22:11

我先说下：
程序块要采用缩进风格编写，缩进的空格数为4个。说明：对于由开发工具自动生成的代码可以有不一致

只看该作者 · 2016-3-25 22:11

相对独立的程序块之间、变量说明之后必须加空行。
示例：如下例子不符合规范。
if (!valid_ni(ni))
{
... // program code
}
repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
应如下书写
if (!valid_ni(ni))
{
... // program code
}
repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;

只看该作者 · 2016-3-25 22:12

较长的语句（ >80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，
操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。
示例：
perm_count_msg.head.len = NO7_TO_STAT_PERM_COUNT_LEN
+ STAT_SIZE_PER_FRAM * sizeof( _UL );
act_task_table[frame_id * STAT_TASK_CHECK_NUMBER + index].occupied
= stat_poi[index].occupied;
act_task_table[taskno].duration_true_or_false
= SYS_get_sccp_statistic_state( stat_item );
report_or_not_flag = ((taskno < MAX_ACT_TASK_NUMBER)

只看该作者 · 2016-3-25 22:12

循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首
示例：
if ((taskno < max_act_task_number)
&& (n7stat_stat_item_valid (stat_item)))
{
... // program code
}
for (i = 0, j = 0; (i < BufferKeyword[word_index].word_length)
&& (j < NewKeyword.word_length); i++, j++)
{
... // program code
}
for (i = 0, j = 0;
(i < first_word_length) && (j < second_word_length);
i++, j++)
{
... // program code
}

只看该作者 · 2016-3-25 22:13

若函数或过程中的参数较长，则要进行适当的划分。
示例：
n7stat_str_compare((BYTE *) & stat_object,
(BYTE *) & (act_task_table[taskno].stat_object),
sizeof (_STAT_OBJECT));
n7stat_flash_act_duration( stat_item, frame_id *STAT_TASK_CHECK_NUMBER
+ index, stat_object );

只看该作者 · 2016-3-25 22:14

不允许把多个短语句写在一行中，即一行只写一条语句。
示例：如下例子不符合规范。
rect.length = 0; rect.width = 0;
应如下书写
rect.length = 0;
rect.width = 0;

只看该作者 · 2016-3-25 22:14

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

只看该作者 · 2016-3-25 22:15

对齐只使用空格键，不使用TAB键。
说明：以免用不同的编辑器阅读程序时，因 TAB 键所设置的空格数目不同而造成程序布局
不整齐，不要使用 BC 作为编辑器合版本，因为 BC 会自动将 8 个空格变为一个 TAB 键，
因此使用 BC 合入的版本大多会将缩进变乱。

只看该作者 · 2016-3-25 22:15

函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格， case语句下的情况处理语句也要遵从语句缩进要求。

只看该作者 · 2016-3-25 22:15

程序块的分界符（如C/C++语言的大括号‘ {’和‘ }’）应各独占一行并且位于同一列，同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以及if、 for、 do、 while、 switch、 case语句中的程序都要采用如上的缩进方式
示例：如下例子不符合规范。
for (...) {
... // program code
}
if (...)
{
... // program code
}
void example_fun( void )
{
... // program code
}
应如下书写。
for (...)
{
... // program code
}
if (...)
{
... // program code
}
void example_fun( void )
{
... // program code
}

只看该作者 · 2016-3-25 22:16

在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加空格；进行非对等操作时，如果是关系密切的立即操作符（如－>），后不应加空格

只看该作者 · 2016-3-25 22:16

采用这种松散方式编写代码的目的是使代码更加清晰。由于留空格所产生的清晰性是相对的，所以，在已经非常清晰的语句中没有必要再留空格，如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格，多重括号间不必加空格，因为在 C/C++语言中括号已经是最清晰的标志了。在长语句中，如果需要加的空格非常多，那么应该保持整体清晰，而在局部不加空格。给操作符留空格时不要连续留两个以上空格。

只看该作者 · 2016-3-25 22:17

示例：
(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)

只看该作者 · 2016-3-25 22:17

一行程序以小于80字符为宜，不要写得过长

只看该作者 · 2016-3-25 22:18

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

只看该作者 · 2016-3-25 22:19

说明性文件（如头文件.h文件、 .inc文件、 .def文件、编译说明文件.cfg等）头部应进行注释，注释必须列出：版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等，头文件的注释中还应有函数功能简要说明。

只看该作者 · 2016-3-25 22:19

示例：下面这段头文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要
包含在内。
/*************************************************
Copyright (C), 1988-1999, Huawei Tech. Co., Ltd.
File name: // 文件名
Author: Version: Date: // 作者、版本及完成日期
Description: // 用于详细说明此程序文件完成的主要功能，与其他模块
// 或函数的接口，输出值、取值范围、含义及参数间的控
// 制、顺序、独立或依赖等关系
Others: // 其它内容的说明
Function List: // 主要函数列表，每条记录应包括函数名及功能简要说明
1. ....
History: // 修改历史记录列表，每条修改记录应包括修改日期、修改
// 者及修改内容简述
1. Date:
Author:
Modification:
2. ...
*************************************************/

只看该作者 · 2016-3-25 22:20

文件头部应进行注释，列出：版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。
示例：下面这段源文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内

只看该作者 · 2016-3-25 22:20

/************************************************************
Copyright (C), 1988-1999, Huawei Tech. Co., Ltd.
FileName: test.cpp
Author: Version : Date:
Description: // 模块描述
Version: // 版本信息
Function List: // 主要函数及其功能
1. -------
History: // 历史修改记录
<author> <time> <version > <desc>
David 96/10/12 1.0 build this moudle
***********************************************************/
说明： Description 一项描述本文件的内容、功能、内部各部分之间的关系及本文件与
其它文件关系等。 History 是修改历史记录列表，每条修改记录应包括修改日期、修改
者及修改内容简述