代码是给人看的,其次才是给机器执行。
很多同学不太理解这句话。认为程序写的运行快效率高就可以了。
为什么还要求代码规范?
因为易于维护和重构是程序必须具备的特征。
根据业界经验,软件的维护成本占整个软件生命期40%-90%。
维护期变更代码的成本,小型系统是开发期的5倍,大型系统(万行代码以上)可以达到倍。
大量的人力都是在维护原有功能而不是实现新功能。
这是为什么代码规范特别重要的原因。
图片来源:黑暗之魂Ⅲ原画集
代码规范不只是注释还包括写程序时应当注意的问题。比如,
写作规范:
1.变量的命名规则
2.函数的命名规则
语句格式:
1.写if语句不能省略大括号
2.写了if必须要写else
3.函数不能超过40行,多余的提取出来做成小的函数等等。
注释规范:
单行注释
函数注释
类注释等
每个大公司都有自己的代码规范,这方面公认的C语言华为做的最好,C++谷歌做的最棒。
有的同学说,我是给公司打工的,写得这么详细公司岂不是想把我踢走就踢走?
从我个人经验来说,给公司打工挣钱只是一方面,还有一方面是经营自己的社会形象。不知道这么说是否合适。
我们在公司干活不是一直在写代码,还会和其它同事打交道。
那么你在公司的表现其实就决定了别人对你的看法。
未来别人有好机会的话,如果觉得你可靠那么一定会找你。
之前我在那篇文章职场避坑指南也说过公司有很多混子,能力有但是程序不好好写。如果大家干活会找这样的人一起吗?
所以我的原则是:
该摸鱼摸鱼,但是自己的工作一定要做好。