华为软件编程规范学习(一)排版

文章目录

排版

  1. 程序块要采用缩进风格编写,缩进的空格数为4个。
    说明:对于由开发工具自动生成的代码可以有不一致。
  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. 较长的语句(>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. 循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分,长表达式要在低优先级操作符处划分新行,操作符放在新行之首。
    示例:
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. 若函数或过程中的参数较长,则要进行适当的划分。
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. 不允许把多个短语句写在一行中,即一行只写一条语句。
    示例:如下例子不符合规范。
rect.length = 0; rect.width = 0;

应如下书写

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

应如下书写:

if (pUserCR == NULL) 
{ 
 return; 
}
  1. 对齐只使用空格键,不使用TAB键。
    说明:以免用不同的编辑器阅读程序时,因 TAB 键所设置的空格数目不同而造成程序布局不整齐,不要使用 BC 作为编辑器合版本,因为 BC 会自动将 8 个空格变为一个 TAB 键,因此使用 BC 合入的版本大多会将缩进变乱。
  2. 函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格,case语句下的情况处理语句也要遵从语句缩进要求。
  3. 程序块的分界符(如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. 在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或者前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如->),后不应加空格。
    示例:
    (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)

注意:一行程序以小于80字符为宜,不要写得过长。

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

<( ̄︶ ̄)Okay.

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值