作为刚刚开始进行软件编程的我来说,感觉有很多困难,除了最基本的语法以外就是不清楚程序最基本的代码规范,最基本的语法通过相应的训练正在逐渐学习,但是前几天同学一句“你的代码不用看内容,一看格式就不专业”作为之后要进入软件行业,并以之为生的我来说,具备最基本的代码风格规范,尤为重要,经过半个学期的训练,下面我将对我学到的一些东西加以总结,既方便自己之后回顾,也可以给那些像我一样的小白们一些帮助,菜鸟初飞,大神勿喷。
如高软课上所讲,当前的公司开发软件特别是大型软件的时候,会发生人员的流动,如何在人员流动以后保证软件开发的持续进行,这对代码风格的规范提出了要求,因为开发人员必须能够对已开发的程序完全了解才能在原来的基础上上继续开发,这对代码的规范性,可读性提出了要求。下面书归正传。
编码风格(coding style)很容易会和编码规范(coding standard)混为一谈,因为这两个词经常会被人换着使用。我认为,编码规范同时包括了编码风格和其它规范,不仅仅指代码格式。例如,像“返回成功/失败的函数应该用一个整数作为返回值”,这样的规则不属于编码风格。编码风格中的规则通常会涉及到下面这些主题:
缩进
空格的使用
Tab的使用
注释
命名习惯
代码行长度
语言特点风格,例如是否使用可有可无的分号。
遵守编码风格有下面三个主要好处:
1. 遵守编码风格使代码更容易维护,如果所有代码中大家使用同一种编码风格,这另外一个程序员快速的扫一眼陌生的代码,就能根据大家约定的编程习惯,推断出代码的作用。
2. 编码风格使形成代码集体所有制,在整个代码库中坚持延用一种常用的编码风格,所以程序员都能更容易的理解、维护。
3. 编码风格能消除纷争,每个程序员都对编码风格有自我认同,只要能达成一致,便于消除这种矛盾。
说完了好处那么我们应该遵循的一些基本的代码规范是什么呢?
下面介绍一些基本的规范:
1.排版:
程序快要采取缩进风格编写,缩进的空格数一般为4位;敲黑板啊!老师说过好几次!所以放在第一条。
相对独立的语句块,变量说明后要加空行;
程序块的分界符如(“{”和“}”)应各自独占一行,并处于同一列,同时引用它们的语句左对齐;
不要把多个短语句写在同一行,即一行只写一个语句;
2.注释:
注释必须做到清晰,准确地描述内容。对于程序中复杂的部分必须有注释加以说明。注释量要适中,过多或过少都易导致阅读困难。
文件头部应进行注释,主是必须列出版权说明,版本号,生成日期,作者,内容,功能,修改等,这一点我现在还没有做到,每次感觉写的代码太短就不想写,其实就是懒。
C语言中使用一组(/* … */)作为注释界定符。
注释内容尽量用英语方式表述。
注释应该出现在要说明的内容之前,而不应该出现在其后。
除了说明变量的用途和语言块末尾使用的注释,尽量不使用行末的注释方式
3.命名规范:
符号常量的命名用大写字母表示;
如果符号常量由多个单词构成,两个不同的单词之间可以用下划线连接。如:
#define MAX_LEN 50
变量命名的基本原则:
可以选择有意义的英文(小写字母)组成变量名,使人看到该变量就能大致清楚其含义。
不要使用人名、地名和汉语拼音。
如果使用缩写,应该使用那些约定俗成的,而不是自己编造的。
多个单词组成的变量名,除第一个单词外的其他单词首字母应该大写。
4.其它一些小技巧和要求:
函数一般情况下应该少于100行,对于菜鸟们,刷什么微博,快滚去码代码,
函数定义一定要包含返回类型,没有返回类型加void
规则还有很多,刚才说的只是一小部分,此处先安利一篇博客http://www.cnblogs.com/xinz/archive/2011/11/20/2255971.html,和一本名为《高质量C++/C编程指南高质量C++/C编程指南》的书,这本书中的前言部分的“编程老手与高手的误区”感觉可以让我们少走不少弯路,最起码不至于被某些大神们带跑偏,建议大家一读。