前言:
作为程序员的我们,最容易打交道的就是代码了,一个个的字符的组合,可以给我们带来巨大的效益,但是我们同时注意一下代码的格式和一些书写规范,相信会有更大的收获和效益呢。
内容:
首先用一个导图来总体把握一下我们平常代码的易出错点吧。
现在就分模块来介绍一下具体的内容吧。
一、注释:
首先应该都知道“注释”是什么吧,在之前的我们学到的文言文中会有注释,解释一些比较难懂的词语,那现在在我们编码的代码中也需要注释,可以帮助我们更好的理解代码的意思,使用户和作者对于程序可以达到同样的理解效果。同样,及时下面有其他人接手程序,然后可以快的进入到理解中,同时也增加里团队的速度和效率。同时,写注释也有一定的规则:
1.要写有价值的注释。不要是想到什么写什么,要精简、易懂。
2.站在读者的角度上。作为书写代码的我们,可能很容易理解自己代码的意义,但是如果是换一个人来读自己的代码,也应该让他们读懂,这就要求我们将一些比较难懂,不易辨别的代码加上注释,方便自己,也方便他人。
3.公布已有的陷阱
4.全局观注释
二.命名规则
在代码中,我们经常会命名一些窗体,也会自定义一些变量等等,这就要求我们养成一个很好的命名习惯,命名要通俗易懂,这样在团队合作中也是可以很好的提高团队开发速度。下面是一些命名规则:
1.把信息装入名字里面。简单的就是要让读者通过名字,就可以直接确定你命名的意思,然后快捷的找到。
2.找到更专业,更有表现力的词语,用具体代替抽象
3.避免与关键字的冲突,如base、date、class等。
4.命名的长度和标识符的缩写也是要注意的
三.审美
我们每天都把自己打扮的漂漂亮亮的,然后每天都朝气蓬勃的,但是代码也需要我们对它“修饰加工”呢,让它整整齐齐的,让其他人一看就可以赏心悦目呢。同时也介绍一些审美的规则吧。
1.空行规则,尊重空间。 不是整篇满满的才是漂亮的,有时候有些“空缺美”也是更好的!
2.养眼的组织结构,尤其要注意一下连字符的使用;
3.个人风格一致性;整个程序的代码,我们应该保持一种自己的风格,不要经常变换,那样子会让人产生一个凌乱的感觉。
4.一屏原则。通过字面,相信大家都知道是什么意思了吧,就是要求我们的代码不要超过自己的屏幕大小,否则对于调试也不方便。
四.异常处理
我们呈现给用户的系统需要完美的,不能时刻的报错,界面登陆不进去,否则会使用户产生厌倦,对于系统失去兴趣。这就要求我们使用日志,时刻记录异常现象的出项。
小结:
以上是我总结的一些关于代码的书写规范,让我们在以后的编程中慢慢的养成良好的书写代码的习惯,在以后的工作中,让我们不仅是个伟大的程序员,更是一个有着良好习惯的程序员。!