|
本帖最后由 席萌0209 于 2018-3-14 16:37 编辑
安富莱C语言编码规范 2--排版
1、程序块要采用缩进风格编写,缩进的空格数为 4 个。
2、相对独立的程序块之间、变量说明之后必须加空行。
- void DemoFunc(void)
- {
- uint8_t i;
- <---- 局部变量和语句间空一行
- /* 功能块 1 */
- for (i = 0; i < 10; i++)
- {
- ...
- }
- <---- 不同的功能块间空一行
- /* 功能块 2 */
- for (i = 0; i < 20; i++)
- {
- ...
- }
- }
复制代码
3、作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。
- if ((ucParam1 == 0) && (ucParam2 == 0) && (ucParam3 == 0)
- || (ucParam4 == 0)) <---- 长表达式需要换行书写
- {
- ......
- }
复制代码
4、不允许把多个短语句写在一行中,即一行只写一条语句。
- rect.length = 0; rect.width = 0; <---- 不正确的写法
- rect.length = 0; <---- 正确的写法
- rect.width = 0;
复制代码
5、对齐使用 TAB 键,1 个 TAB 对应 4 个字符位。
6、函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格,case 语句下的情况处理语句也要遵从语句缩进要求。
7、程序块的分界符(如大括号‘{’和‘}’ )应各独占一行并且位于同一列,同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以及 if、for、do、while、switch、case 语句中的程序都要采用如上的缩进方式。对于与规则不一致的现存代码,应优先保证同一模块中的风格一致性。
- for (...) { <---- 不规范的写法
- ... /* program code */
- }
- for (...)
- { <---- 规范的写法
- ... /* program code */
- }
- if (...)
- { <---- 不规范的写法
- ... /* program code */
- }
- if (...)
- { <---- 规范的写法
- ... /* program code */
- }
复制代码
8、在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或者前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如->),后不应加空格。
说明:采用这种松散方式编写代码的目的是使代码更加清晰。
由于留空格所产生的清晰性是相对的,所以,在已经非常清晰的语句中没有必要再留空格,如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格,多重括号间不必加空格,因为在 C语言中括号已经是最清晰的标志了。
在长语句中,如果需要加的空格非常多,那么应该保持整体清晰,而在局部不加空格。给操作符留空格时不要连续留两个以上空格。
示例:
(1)逗号、分号只在后面加空格。
(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 等关键字更为突出、明显,函数名与其后的括号之间不加空格,以与保留字区别开。
|
|