c语言的书写风格
注释是一件很好的事情,但是过多的注释也是危险的,不要试图区解 释你的代码是注释如何如何的好。你应该将代码写得更好,而不是花 费大量的时间去解释那些糟糕的代码。
通常情况下,你的注释是说明你的代码做些什么,而不是怎么做 的。而且,要试图避免将注释插在一个函数体里。假如这个函数确实 很复杂,你需要在其中有部分的注释,最好还是把复杂的函数拆分成 几个简单的函数。也可以将注释写在函数前,告诉别人它做些什么事 情,和可能为什么要这样做。
使用具有描述性名字的有帮助的函数。
另外一个需要考虑的是局部变量的数量。他们不应该超过5-10个,
否则你有可能会出错。重新考虑这个函数,将他们分割成更小的函数。
人的大脑通常可以很容易的记住7件不同的事情,超过这个数量会引
起混乱。你知道你很聪明,但是你可能仍想去明白2周以前的做的事
情。
5 .注释
• 注释一般采取的两种方式:对一个程序块注释和对一行程序注释。 /*比较x,y大小*/ if(x>y) { t=x; x=y; y=t; /*交换x,y*/ }
1.缩进
• 对于函数,选择,循环控制,在进入下级的程序段时,为了使结构清 晰,一般将下级的程序段向后缩进一段位置。缩进的大小是为了清楚 的定义一个块的开始和结束,特别是当你已经编写了很长的代码时, 你会发现一个大的缩进格式使得你对程序的理解更容易,因为程序更 有层次感,可以最快的找到需要查看的程序块。 建议使用一个TAB位置(8个字节)进行缩进,有些代码编辑工具显 示一个TAB位置为4个字节,这些都能使程序更清晰。现在,有一些 人说,使用8个字符的缩进使得代码离右边很近,在80个字符宽度的 终端屏幕上看程序很难受。回答是,但你的程序有3个以上的缩进的 时候,你就应该修改你的程序。总之,8个字符的缩进使得程序易读, 还有一个附加的好处,就是它能在你将程序变得嵌套层数太多的时候 给你警告。这个时候,你应该修改你的程序,太多的嵌套对于程序执 行的效率和易读性都是致命的杀手,可以考虑使用函数或者改变程序 结构。
②if((x>100)||(x<0))
• (1) if(x>y) { t=x; x=y; y=t; }
(2)Kernighan和Ritchie的经典方式 if(x>y){ t=x; x=y; y=t; }
(3) if(x>y) { t=x; x=y; y=t;} 推荐使用(1)方式,很明显,这种方式能更清楚的看到
程序块的开始和结束的位置。但对于很简单的程序块,也 可以使用(3)方式。
个屏幕,并且只作一件事情,而且将它做好。
一
是,如果你已经写了简单但长度较长的的函数,而且你已经对不同的
情况做了很多很小的事情,写一个更长一点的函数也是无所谓的。
然而,假如你要写一个很复杂的函数,而且你已经估计到假如一
般人读这个函数,他可能都不知道这个函数在说些什么,这个时候,
例一
• int fother() {
}
程序块 if(...) {
} else {
}
程序块 程序块
for(...) {
}
程序块
• int fother() { 程序块
if(...) { 程序块
} else { 程序块
} for(...) { 程序块
} }
2 .大括号的位置
• 一般情况下,有下列几种书写方式:
3 .命名系统
• 除了常用的规则,如#define 常量应全部大写,变 量命名的基本规则等之外,还要养成一个良好的 命名的习惯。不要使用汉语拼音命名,尽量使用 英文单词,常用的缩写,下划线,数字等,这样 更容易理解变量的意义。但是也要避免过长的变 量名和函数名。
4 .函数
•
函数应该短小而迷人,而且它只作一件事情。它应只覆盖一到两
C语言的书写风格
当开发人员把C语言程序写的越来越长的时候, 他们发现维护这些程序需要花更多的功夫去读以前所 编写的程序。保持一种良好的编码风格,对于一个开 发团队或者自主开发者都是一件好事情。在这里要介 绍的编程风格就是为了让初学者了解C语言的一些编 写风格,使自己编写的程序,可读性,移植性,可维 护性等更好,这是学习C语言必须学习的一种技能。 这就象我们写文章一样,段落缩进两个文字这样的风 格。
5 .注释
• 注释一般采取的两种方式:对一个程序块注释和对一行程序注释。 /*比较x,y大小*/ if(x>y) { t=x; x=y; y=t; /*交换x,y*/ }
注释是一件很好的事情,但是过多的注释也是危险的,不要试图区解 释你的代码是注释如何如何的好。你应该将代码写得更好,而不是花 费大量的时间去解释那些糟糕的代码。
通常情况下,你的注释是说明你的代码做些什么,而不是怎么做 的。而且,要试图避免将注释插在一个函数体里。假如这个函数确实 很复杂,你需要在其中有部分的注释,最好还是把复杂的函数拆分成 几个简单的函数。也可以将注释写在函数前,告诉别人它做些什么事 情,和可能为什么要这样做。
5 .空格与空行
• 不要让自己的程序过于拥挤,这样同样影响可读 性,善于使用空格区分一句程序中的变量,符号, 表达式等,使他们对照整齐或者更清晰。善于使 用空行区分程序块。 例如: name = “young” age = 21 college = “ZIT” 例如: ①if ( (x>100) || (x<0) )