软件编写规范(排版篇)

//摘抄自华为软件编写规范
1、较长的语句(>80 字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读 。

perm_count_msg.head.len = NO7_TO_STAT_PERM_COUNT_LEN 
                     + STAT_SIZE_PER_FRAM * sizeof( _UL ); 

2、循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分,长表达式要在低优先级操作符处划分新行,操作符放在新行之首 。

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  
} 

3、若函数或过程中的参数较长,则要进行适当的划分

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 ); 

4、不允许把多个短语句写在一行中,即一行只写一条语句
5、if 、for 、do 、while 、case 、switch 、default 等语句自占一行,且 if 、for 、do 、while 等语句的执行语句部分无论多少都要加括号{}
6、对齐只使用空格键,不使用 TAB 键
7、函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格,case 语句下的情况处理语句也要遵从语句缩进要求
8、程序块的分界符(如 C/C++ 语言的大括号„{‟ 和„}‟ )应各独占一行并且位于同一列,同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以及 if 、for 、do 、while 、switch 、case 语句中的程序都要采用如上的缩进方式

for (...)  
{ 
     ... // program code 
} 
if (...)  
{ 
     ... // program code 
} 
void example_fun( void ) 
{ 
     ... // program code 
} 

9、在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或者前后要加
空格;进行非对等操作时,如果是关系密切的立即操作符(如-> ),后不应加空格。
说明:采用这种松散方式编写代码的目的是使代码更加清晰
由于留空格所产生的清晰性是相对的,所以,在已经非常清晰的语句中没有必要再留空格,如果语句已足
够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格,多重括号间不必加空格,因为在 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) ifforwhile、switch 等与后面的括号间应加空格,使 if 等关键字更为突出、明显。 
if (a >= b && c > d) 
  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

打赏作者

COSummer

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

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

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

打赏作者

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

抵扣说明:

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

余额充值