华为公司代码编码规范

原文链接：http://blog.sina.com.cn/s/blog_61176a740100ffer.html

1-1：程序块要采用缩进风格编写，缩进的空格数为4个。

说明：对于由开发工具自动生成的代码可以有不一致。

1-2：相对独立的程序块之间、变量说明之后必须加空行。
示例：如下例子不符合规范。
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;

1-3：较长的语句（>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)
&& (n7stat_stat_item_valid(stat_item))
&&(act_task_table[taskno].result_data != 0));

1-4：循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首。
示例：
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
}

1-5：若函数或过程中的参数较长，则要进行适当的划分。
示例：
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 );

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

应如下书写
rect.length = 0;
rect.width = 0;

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

应如下书写：
if (pUserCR == NULL)
{
return;
}

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

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

1-10：程序块的分界符（如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
}

1-11：在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加空格；进行非对等操作时，如果是关系密切的立即操作符（如－>），后不应加空格。
说明：采用这种松散方式编写代码的目的是使代码更加清晰。
由于留空格所产生的清晰性是相对的，所以，在已经非常清晰的语句中没有必要再留空格，如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格，多重括号间不必加空格，因为在C/C++语言中括号已经是最清晰的标志了。
在长语句中，如果需要加的空格非常多，那么应该保持整体清晰，而在局部不加空格。给操作符留空格时不要连续留两个以上空格。

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

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

2 注释

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

2-2：说明性文件（如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等）头部应进行注释，注释必须列出：版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等，头文件的注释中还应有函数功能简要说明。
示例：下面这段头文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。

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

说明：Description一项描述本文件的内容、功能、内部各部分之间的关系及本文件与其它文件关系等。History是修改历史记录列表，每条修改记录应包括修改日期、修改者及修改内容简述。

2-4：函数头部应进行注释，列出：函数的目的/功能、输入参数、输出参数、返回值、调用关系（函数、表）等。
示例：下面这段函数的注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。

2-5：边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。

2-6：注释的内容要清楚、明了，含义准确，防止注释二义性。
说明：错误的注释不但无益反而有害。

2-7：避免在注释中使用缩写，特别是非常用缩写。
说明：在使用缩写时或之前，应对缩写进行必要的说明。

2-8：注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。
示例：如下例子不符合规范。

repssn_ind =ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;

应如下书写

2-9：对于所有有物理含义的变量、常量，如果其命名不是充分自注释的，在声明时都必须加以注释，说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。
示例：

2-10：数据结构声明(包括数组、结构、类、枚举等)，如果其命名不是充分自注释的，必须加以注释。对数据结构的注释应放在其上方相邻位置，不可放在下面；对结构中的每个域的注释放在此域的右方。
示例：可按如下形式说明枚举/数据/联合结构。

2-11：全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。
示例：

华为公司代码编码规范相关推荐

代码规范之华为公司代码规范
华为公司代码规范转于http://blog.sina.com.cn/s/blog_61176a740100ffer.html 内容简要:写代码习惯以及注释的要求. 1-1:程序块要采用缩进风格编写, ...
实验一静态代码编码规范审计实验
实验一静态代码编码规范审计实验一.PHPstudy 搭建 DVWA DVWA 是 OWASP 官方编写的 PHP 网站,包含了各种网站常见漏洞,可以学习攻击及修复方式.一个好的靶场,是黑客和网络安 ...
HTML代码编码规范
博客来自:http://www.gbtags.com/gb/tutorials/215/1163.htm 个人主页:http://www.itit123.cn/ 更多干货等你来拿 HTML代码编码规范 ...
华为java安全编码规范_Java安全编码之SQL注入
随着互联网的发展,Java语言在金融服务业.电子商务.大数据技术等方面的应用极其广泛.Java安全编码规范早已成为SDL中不可或缺的一部分.本文以Java项目广泛采用的两个框架Hibernate和My ...
华为公司软件编程规范
目录 1 排版 6 2 注释 11 3 标识符命名 18 4 可读性 20 5 变量.结构 22 6 函数.过程 28 7 可测性 36 8 程序效率 40 9 质量保证 44 10 代码编辑.编 ...
python 代码格式规范脚本_Python编码规范
Python自动化测试代码编码规范一.适用范围: 本规则基础为Python标准PEP8,在此基础上加了我司测试部编码规范,适用于测试部所有Python脚本编写是采用的规则. 二.编码: 所有的 Py ...
通过制定编码规范的过程来说明《学会放弃、妥协也是个大进步，也是相当的提高工作效率》...
为什么80%的码农都做不了架构师?>>> 我曾经在一个比较有规模的IT公司工作,由于公司领导的经营能力还是蛮强,这个公司生存得还可以.大公司了,跟小公司创业型公司差别很大,更得 ...
基于 Node.js + Koa 构建完整的 Web API （配置 ESLint 和使用 Airbnb 编码规范）
主题内容:基于 Node.js + Koa 构建完整的 Web API (配置 ESLint 和使用 Airbnb 代码规范) 背景描述:上一篇基于 Node.js + Koa 构建完整的 Web ...
编码规范可能只是一块遮羞的破布。。。
关注+星标公众号,不错过精彩内容转自 | 裸机思维分享王工的一篇文章,前方观点可能与你有冲突据说,赵国的首都邯郸的人走路的姿态很好看,动作非常优雅.轻快. 燕国有一个少年听到这个传说,非常羡慕邯 ...

华为公司代码编码规范

华为公司代码编码规范相关推荐

最新文章

热门文章

华为公司 代码编码规范

华为公司 代码编码规范相关推荐

最新文章

热门文章

华为公司代码编码规范

华为公司代码编码规范相关推荐