怎么写出优秀的软件代码
大家好,今天跟大家分享一下怎么写出好的代码。码农现在是中国就业的绝对主力的。那么怎么写出好代码,这是很多人追求。
软件研发属于良心活,很难监控,认不认真差一万八千里,首先要有认真的心,做好的心,这一点是根本。
脸书的创始人扎克伯格说过,好的程序员和不好的程序员他的,效率可以差100倍,也就是说的不好的程序员可能做负的贡献,也就是写的代码漏洞太多,bug太多,要别人给他擦屁股才能解决问题。
第一点来讲,就是规范性
代码要写的规范。可读性好,写得清爽,可维护性强,可扩展性强。那么,怎么做到呢?
规范性的第一点呢?就是命名。
1)名字的含义准确,英语不好的多差字典,要用准确的英语 术语要用准确的术语 不能用单个字母,不能用拼音。类型定义。变量定义命名都要准确,如果你搞的那个名字得了a,b,c,d,e,那别人肯定就看不懂。
2)变量要包含数据类型,数据类型啊,指针就是指针,你是整型就是整整,int8就是int8,能看清类型,用的时候就不会出错
3)定义要考虑作用域,就说你的是在哪个范围有效的,而不能这个没有作用域的话。别一用啊,那现在一周超过中于范围了,可能用的又不准确了,所以的话,这是那个很关键的。
4)注释,对于算法部分要有注释,代码修改要注释修改原因
5)自注释是最好的注释,用命名,用语法的正确使用来实现自注释,可读性就强。
6)语法的使用要合理,要得当。比如if else分支不能太多,分支多要有switch case
7)异常分支要处理,default分支要处理,异常要catch。
8)日志,告警要准确打点,要符合日志和告警规范。
第二点来讲,代码静态检查和问题清零
利用工具检查来提高效率。各种编程语言都有代码静态检查插件,用静态检查来检查代码,是非常好的规范性和质量检查工具。最好能做到问题清零,包括编译的问题,也最好清零。因为很多人会有认为这些提示问题,不解决也没啥,这都是隐患。其实不是,可能隐藏这问题。
第三点来讲,就是代码同行评审,也叫代码走读
代码走读是质量效率最高的一项质量活动 发现问题越早成本越低。那么代码走读,就是发现问题最早的一个环节。而且是效果最好的。多个同事交叉评审代码,对相互了解和后面维护也有好处。相互学习,对培养人也有好处。
第四点来讲,结对编程
结对编程是敏捷的一个优秀实践,就是两个人一起来写代码,一个人写另外一个人观察,然后交换过来,另一个人写这个人观察,这样的话,就可以互相学习,互相纠正,互相审核代码,这样的话,两个人成长会非常快,一种的是两个水平差不多的,还一种的就是老员工带新员工老带新的一个方式。
第五点来讲,单元测试测试驱动开发
很多编程语言都有测试脚本支持,JUnit C++Unit ,用脚本来写单元测试用力,边开发边写测试用例,先写测试用例再写代码,这是正确的方法 很多人不重视单元测试;单元测试是最有效的测试质量活动,作者自己测试,效率最高。这也是自动化测试的基础 后面的测试都可以继承这些用力,取其中的一部分,加上测试驱动脚本 自动化测试工厂也是敏捷的优秀实践。
单元测试这里面就会有一个大家疑惑的问题。就是覆盖率的问题,说要100%覆盖,也有覆盖力的统计工具。实际上100%的覆盖率太难了,而且很多代码分支,没那么容易构造测试用例,我认为代码走读结合单元测试会更好,实际上代码走读之后,其实你可以判断存在问题的概率就非常小了,这样的话再配合80%左右的单元测试覆盖率就可以了。
今天给大家分享这么多,希望对大家写出好代码有些帮助。