硬汉嵌入式论坛

 找回密码
 立即注册
查看: 8477|回复: 4
收起左侧

安富莱C语言编码规范 2--排版

[复制链接]

740

主题

1326

回帖

3546

积分

管理员

春暖花开

Rank: 9Rank: 9Rank: 9

积分
3546
QQ
发表于 2018-3-14 16:35:42 | 显示全部楼层 |阅读模式
本帖最后由 席萌0209 于 2018-3-14 16:37 编辑

安富莱C语言编码规范 2--排版

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

2、相对独立的程序块之间、变量说明之后必须加空行。
  1. void DemoFunc(void)

  2. {

  3. uint8_t i;

  4. <---- 局部变量和语句间空一行

  5. /* 功能块 1 */

  6. for (i = 0; i < 10; i++)

  7. {

  8. ...

  9. }

  10. <---- 不同的功能块间空一行

  11. /* 功能块 2 */

  12. for (i = 0; i < 20; i++)

  13. {

  14. ...

  15. }

  16. }
复制代码

3、作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。
  1. if ((ucParam1 == 0) && (ucParam2 == 0) && (ucParam3 == 0)

  2. || (ucParam4 == 0)) <---- 长表达式需要换行书写

  3. {

  4. ......

  5. }
复制代码

4、不允许把多个短语句写在一行中,即一行只写一条语句。
  1. rect.length = 0; rect.width = 0; <---- 不正确的写法

  2. rect.length = 0; <---- 正确的写法

  3. rect.width = 0;
复制代码

5、对齐使用 TAB 键,1 个 TAB 对应 4 个字符位。

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

7、程序块的分界符(如大括号‘{’和‘}’ )应各独占一行并且位于同一列,同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以及 if、for、do、while、switch、case 语句中的程序都要采用如上的缩进方式。对于与规则不一致的现存代码,应优先保证同一模块中的风格一致性。
  1. for (...) { <---- 不规范的写法

  2. ... /* program code */

  3. }

  4. for (...)

  5. { <---- 规范的写法

  6. ... /* program code */

  7. }

  8. if (...)

  9. { <---- 不规范的写法

  10. ... /* program code */

  11. }

  12. if (...)

  13. { <---- 规范的写法

  14. ... /* program code */

  15. }
复制代码

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

示例:
(1)逗号、分号只在后面加空格。
  1. int_32 a, b, c;
复制代码

(2)比较操作符,赋值操作符"="、 "+=",算术操作符"+"、"%",逻辑操作符"&&"、"&",位域操作符"<<"、"^"等双目操作符的前后加空格。
  1. if (current_time >= MAX_TIME_VALUE)

  2. a = b + c;

  3. a *= 2;

  4. a = b ^ 2;
复制代码

(3)"!"、"~"、"++"、"--"、"&"(地址运算符)等单目操作符前后不加空格。
  1. *p = 'a'; /* 内容操作"*"与内容之间 */

  2. flag = !isEmpty; /* 非操作"!"与内容之间 */

  3. p = &mem; /* 地址操作"&" 与内容之间 */

  4. i++; /* "++","--"与内容之间 */
复制代码

(4)"->"、"."前后不加空格。
  1. p->id = pid; /* "->"指针前后不加空格 */
复制代码

(5)if、for、while、switch 等与后面的括号间应加空格,使 if 等关键字更为突出、明显,函数名与其后的括号之间不加空格,以与保留字区别开。
  1. if (a >= b && c > d)
复制代码

努力打造安富莱高质量微信公众号:点击扫描图片关注
回复

使用道具 举报

32

主题

295

回帖

391

积分

高级会员

积分
391
发表于 2018-6-14 08:58:18 | 显示全部楼层
编码规范,学习了,谢谢
回复

使用道具 举报

7

主题

190

回帖

216

积分

高级会员

积分
216
发表于 2019-9-23 10:48:30 | 显示全部楼层
学习了,谢谢
回复

使用道具 举报

1

主题

5

回帖

8

积分

新手上路

积分
8
发表于 2019-10-12 10:17:38 | 显示全部楼层
请教下,第  7、程序块的分界符 中介绍  两个 if 没有看出区别,尤其第一个if 不规范,麻烦解答下,谢谢。
回复

使用道具 举报

1万

主题

6万

回帖

10万

积分

管理员

Rank: 9Rank: 9Rank: 9

积分
107414
QQ
发表于 2019-10-12 12:44:25 | 显示全部楼层
zhangkaiy122 发表于 2019-10-12 10:17
请教下,第  7、程序块的分界符 中介绍  两个 if 没有看出区别,尤其第一个if 不规范,麻烦解答下,谢谢。

网络没有编辑好,错误的那个左括号有措位
回复

使用道具 举报

您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

QQ|小黑屋|Archiver|手机版|硬汉嵌入式论坛

GMT+8, 2024-5-30 09:59 , Processed in 0.155678 second(s), 26 queries .

Powered by Discuz! X3.4 Licensed

Copyright © 2001-2023, Tencent Cloud.

快速回复 返回顶部 返回列表