理论教育 C语言程序排版格式技巧

C语言程序排版格式技巧

时间:2023-11-21 理论教育 版权反馈
【摘要】:排版工整、注释规范的代码会让人产生继续读下去的想法,无形中提高了工作效率。因此,程序的排版格式是十分重要的。软件开发工程师在提高自己编程水平的同时,要注重程序的排版格式,让自己的代码易于阅读和维护。图1-23例1.5的流程图程序块采用缩进风格编写,每级缩进4个空格。编译预处理命令可以顶格。

C语言程序排版格式技巧

排版工整、注释规范的代码会让人产生继续读下去的想法,无形中提高了工作效率。因此,程序的排版格式是十分重要的。软件开发工程师在提高自己编程水平的同时,要注重程序的排版格式,让自己的代码易于阅读和维护。比较好的程序排版格式如下。

图1-23 例1.5的流程图

(1)程序块采用缩进风格编写,每级缩进4个空格。

说明:当前各种编辑器/IDE都支持TAB键自动转空格输入,需要打开相关功能并设置相关功能。编译预处理命令可以顶格。

(2)赋值操作符、算术操作符、比较操作符、逻辑操作符、位操作符等,如“=”“+=”“+”“*”“%”“>=”,“<,“&&”“||”“<<”等二元操作符的前后要加空格,但一元操作符如“!”“++”“--”“&”(取地址运算符)等前后不加空格。关系密切的立即操作符如“ ->”“.”前后不加空格。

(3 ) if, for, while, switch等与后面的括号间加空格,使if等关键字更为突出。在函数名之后不留空格,紧跟左括号“(”,以与关键字作区别。但在函数定义的参数之间要留空格,例如function(a, b, c)。

(4)在一行代码的结尾之后不留空格。

(5)多个短语句(包括赋值语句)不允许写在同一行中,即一行只写一条语句。

反例:

正例:

(6) if, else, for, do, while, case, switch, default等语句独占一行,执行语句不要紧跟其后。不论执行语句有多少都要加“{ }”,程序的分界符“{”和“}”应独占一行并且与引用它们的语句左对齐。 “{ }”之内的代码块使用缩进规则对齐(一般缩进4个空格)。

假设定义了两个整型变量iVal1和iVal2,如果iVal 1大于iVal2,那么将iVal2的值赋给iVal1,则正、反示例如下。

反例:

正例:

(7)关于空行。

1)空行起着分割程序段落的作用,适当的空行将使程序的布局更加清晰。(www.daowen.com)

2)在每个函数定义结束之后都要加空行(两个函数之间建议添加两个以上的空行)。

3)函数体首尾不要留空行,函数体中也不要随意添加空行。在函数体中,空行用于分割关系不紧密的代码段。

4)相对独立的程序块之间、变量说明之后必须加空行。

假设定义了一个整型变量iVal1,并将char型重定义为INT8 (typedef signed char INT8 ; ),则正、反示例如下。

反例:

正例:

(8)一条语句不能过长,若不能拆分则需分行来写。换行时,建议采用以下规则。

1)换行时要增加一级缩进,使代码的可读性更好。

2)低优先级操作符处划分新行;换行时,操作符也要放下来,并置于新行首。

3)换行时,建议一个完整的语句放在一行,不要根据字符数断行。

(9)关于注释。

1)注释符(包括“/*”“*/”和“//”)与注释内容之间要用一个空格进行分隔,这样可以使注释的内容部分更加清晰。

2)注释的位置要与被描述的代码相邻,可以放在代码的上方或右方,但不能放在代码的下方。

3)注释应当简单、准确、易懂,防止二义性。尽量避免在注释中使用缩写,特别是不常用的缩写。

4)要边写代码边注释,在修改代码的同时修改相应的注释,以保证注释与代码相一致。

5)巧妙或复杂的代码段前要添加注释,比较隐晦的地方要在代码适当的位置添加注释。

(10)源程序中关系较为紧密的代码应尽可能相邻。

关于头文件、源文件的格式,请参考本书各章的实例。各章的实例代码均是基于开发项目实践中的编码规范编写的。由于版面所限,教材中各章的例题均未按程序的排版格式要求留出空行(仅两个函数之间留了一个空行)。部分章节习题中的代码采用某些考试机构的试题格式,未按程序的排版格式要求编写。

免责声明:以上内容源自网络,版权归原作者所有,如有侵犯您的原创版权请告知,我们将尽快删除相关内容。

我要反馈