前面讲霸哥(bug)产生原因的时候,提到过注释不清等代码规范问题。本节课微米老师详细讲一下什么是代码规范,以及遵守代码规范的重要意义。
不以规矩,不能成方圆是出自《孟子》的《离娄章句上》。讲的是人人都需要遵守已定的各种规章和制度,这样社会才能正常的运转。
各行各业,生活的方方面面,都有规矩。编程也不例外。其中,最基本的就是编码规范。
编码规范是一组规则,它们规定了在编写代码时应该遵循的标准化规范。这些规则旨在使代码更易于理解、更易于维护和更易于扩展。遵循编码规范的好处是可以减少 bug 的数量,提高代码的可读性和可维护性。
编码规范主要包括命名、版式、注释等几个方面。
其中命名包括变量、类、方法、文件名、数据库、表、字段、接口等方面。
版式包括缩进、换行、对齐、大括号、循环体、逻辑判断等方面。
注释包括包注释、文件注释、类注释、方法注释、参数注释、变量注释、代码片段注释等。
编码不规范容易引发各种问题,比如:
1.影响团队合作,降低效率;
2. 提高维护成本;
3. 引发各种 bug;
4. 不利于代码审查,甚至造成安全漏洞;
5. 不利于程序员自身的成长。
由于编码不规范造成的人员伤亡,设备损失等案例也比比皆是。
2018年9月19日,美国威斯康星州一家名为WTS Paradigm的开发商办公楼内,一名程序员突然拿出一把半自动手枪向周围4名同事开火。
当时这件事在国内外引起了广泛的讨论,比较可信的说法是:“同事不写注释,不遵循驼峰命名,括号换行,最主要还天天 git push -f 等因素”激怒了这名行凶者。
巴西的阿丽亚娜5型运载火箭,由于缩进规范不当,导致程序中的一些数据被错误复制,最终导致火箭发射失败,巨额投资付之东流。
2011年,美国电力公司PG&E因为缺少安全规范和漏洞检查,导致9人死亡,这起事故的直接原因是由于编写代码时没有考虑安全漏洞,导致了攻击者可以远程控制电力设备。
虽然这些只是极端的个例,不过也说明代码规范是非常重要的。尤其团队协作,开发大型项目时。
希望能够引起同学们对编码规范的重视,养成好的编码习惯并坚持下去。
1、不要乱起变量名
变量名是指在程序中用来标识变量的名称。在编程中,变量名的选择非常重要。变量名应该能清晰地表达变量的意义,而不能是不相关的单词或缩写。如果变量名不规范,容易引起程序逻辑混乱,增加了程序员的心智负担,降低了代码的可读性和可维护性。
2、花括号不能省
花括号是编程语言中的一种语法符号,用于表示代码块。在编程中,为了增加代码的可读性和易于维护,我们通常会将花括号放在独立的一行。如果花括号不规范地使用,可能会导致代码逻辑混乱,增加了程序员的心智负担,降低了代码的可读性和可维护性。
3、不缩进是要死人的
缩进是指将代码块中的每一行代码都向右移动一定的距离,以显示出代码块的层次结构。在编程中,缩进通常用于表示代码块的嵌套关系。如果不规范地使用缩进,可能会导致代码逻辑混乱,增加了程序员的心智负担,降低了代码的可读性和可维护性。
好了,本次课到这里就结束了,感谢同学们的观看。
扫码查看1条评论