C语言——程序的版式

前言

  • 版式虽然不会影响程序的功能,但会影响可读性。程序的版式追求清晰、美观,是程序风格的重要构成因素
  • 可以把程序的版式比喻为“书法”。好的“书法”可让人对程序一目了然,看得兴致勃勃。差的程序“书法”如螃蟹爬行,让人看得索然无味,更令维护者烦恼有加。请程序员们学习程序的“书法”,弥补大学计算机教育的漏洞,实在很有必要
  • 接下来让我开始学习吧!

1. 空行

  • 空行起着分隔程序段落的作用。空行得体(不过多也不过少)将使程序的布局更加清晰。空行不会浪费内存,虽然打印含有空行的程序是会多消耗一些纸张,但是值得。所以不要舍不得用空行。

规则1-1:

  • 在每个类声明之后、每个函数定义结束之后都要加空行。参见示例2-1(a)

规则1-2:

  • 在一个函数体内,逻揖上密切相关的语句之间不加空行,其它地方应加空行分隔。参见示例 2-1(b )

在这里插入图片描述

2. 代码行

规则2-1:

  • 一行代码只做一件事情,如只定义一个变量,或只写一条语句。这样的代码容易阅读,并且方便于写注释

规则2-2:

  • if、for、while、do 等语句自占一行,执行语句不得紧跟其后。不论执行语句有多少都要加{}。这样可以防止书写失误。

在这里插入图片描述

建议2-1:

  • 尽可能在定义变量的同时初始化该变量(就近原则)
  • 因为如果变量的引用处和其定义处相隔比较远,变量的初始化很容易被忘记。如果引用了未被初始化的变量,可能会导致程序错误。本建议可以减少隐患。例如
int width = 10; // 定义并初绐化 width 
int height = 10; // 定义并初绐化 height 
int depth = 10; // 定义并初绐化 depth
int arr[10] = { 0 };//定义并初始化数组arr
int arr[n];//这里的变长数组是特例

3. 代码行内的空格

规则3-1:

  • 关键字之后要留空格。像 const、virtual、inline、case 等关键字之后至少要留一个空格,否则无法辨析关键字。像 if、for、while 等关键字之后应留一个空格再跟左括号‘(’,以突出关键字

规则3-2:

  • 函数名之后不要留空格,紧跟左括号‘( ’,以与关键字区别

规则3-3:

  • ‘( ’向后紧跟,‘ )’、‘ ,’、‘ ; ’向前紧跟,紧跟处不留空格

规则3-4:

  • ‘ ,’之后要留空格,如 Function(x, y, z)。如果‘;’不是一行的结束符号,其后要留空格,如 for (initialization; condition; update)

规则3-5:

  • 赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符,如“ = ”、“ += ” “ >= ”、“ <= ”、“ + ”、“ * ”、“ % ”、“ && ”、“ || ”、“ << ”,“ ^ ”等二元操作符的前后应当加空格。

规则3-6:

  • 一元操作符如“ ! ”、“ ~ ”、“ ++ ”、“ - - ”、“ & ”(地址运算符)等前后不加空格

规则3-7:

  • 像“[]” 、“ . ”、“ -> ”这类操作符前后不加空格

建议3-1:

  • 对于表达式比较长的 for 语句和 if 语句,为了紧凑起见可以适当地去掉一些空格,如 for (i=0; i<10; i++)和 if ((a<=b) && (c<=d))
  • 光用文字表述比较抽象,请见下图:

在这里插入图片描述

4. 对齐

规则4-1:

  • 程序的分界符‘{’和‘}’应独占一行并且位于同一列,同时与引用它们的语句左对齐。

规则4-2:

  • { }之内的代码块在‘{’右边数格处左对齐。

在这里插入图片描述

5. 长行拆分

规则5-1:

  • 代码行最大长度宜控制在 70 至 80 个字符以内。代码行不要过长,否则眼睛看不过来,也不便于打印。

规则5-2:

  • 长表达式要在低优先级操作符处拆分成新行,操作符放在新行之首(以便突出操作符)。拆分出的新行要进行适当的缩进,使排版整齐,语句可读。

在这里插入图片描述

6. 修饰符的位置

  • 修饰符 * 和 & 应该靠近数据类型还是该靠近变量名,是个有争议的活题。
  • 若将修饰符 * 靠近数据类型,例如:int* x; 从语义上讲此写法比较直观,即 x是 int 类型的指针。
  • 上述写法的弊端是容易引起误解,例如:int* x, y; 此处 y 容易被误解为指针变量。虽然将 x 和 y 分行定义可以避免误解,但并不是人人都愿意这样做

规则6-1:

  • 应当将修饰符 * 和 & 紧靠变量名
char *name;
int *x, y; // 此处 y 不会被误解为指针 

7. 注释

  • C 语言的注释符为“//”。C++语言中,程序块的注释常采用“//”,行注释一般采用“//…”。注释通常用于:
  1. 版本、版权声明;
  2. 函数接口说明;
  3. 重要的代码行或段落提示

规则7-1:

  • 注释是对代码的“提示”,而不是文档。程序中的注释不可喧宾夺主,注释太多了会让人眼花缭乱。注释的花样要少

规则7-2:

  • 如果代码本来就是清楚的,则不必加注释。否则多此一举,令人厌烦。例如
i++; // i 加 1,多余的注释

规则7-3:

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

规则7-4:

  • 注释应当准确、易懂,防止注释有二义性。错误的注释不但无益反而有害

规则7-5:

  • 尽量避免在注释中使用缩写,特别是不常用缩写。

规则7-6:

  • 注释的位置应与被描述的代码相邻,可以放在代码的上方或右方,不可放在下方

规则7-7:

  • 当代码比较长,特别是有多重嵌套时,应当在一些段落的结束处加注释,便于阅读

在这里插入图片描述

  • 以上就是代码在编写过程中要注意的事项了
  • 恭喜你,今天又遥遥领先了别人!

在这里插入图片描述

评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

打赏作者

看落日的YT

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

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

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

打赏作者

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

抵扣说明:

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

余额充值