金木编程

公众号:金木编程

导航

如何提升代码质量

一、代码质量差表现在哪些方面:

(1)可读性:函数命名随意,实现逻辑混乱,代码格式不规范。
(2)可靠性:程序运行不稳定,bug太多。
(3)维护性:代码逻辑没有层次,混成一团,很难维护改进。
(4)移植性、重用性:许多人写的代码,只能自己使用,很少有能共享的功能性代码。
(5)高效性:很少从算法、资源占用、执行效率等角度去考虑,经常导致软件性能问题。

二、解决方法(个人角度)
(1)要尽量提升代码可读性。不仅写出计算机可以理解的代码,还要写出人类容易理解的代码。
(2)熟悉自己所使用的程序语言。实际编程时,写法、用法要标准,多用API类库。
(3)培养严谨的逻辑思维能力,流程的每个细节都要考虑到。
(4)养成规范的编程习惯,如代码缩进、参数校验、异常处理、添加注释等。规范的代码可以减少bug处理,在实际项目中,复杂的算法或逻辑只占很小的
比例,大部分功能都不复杂,规范的代码可以大大减少bug数量。
(5)添加足够多的单元测试。
(6)养成自我测试习惯。软件研发作为一项工程而言,问题发现的越早,解决的代价就越低。程序员如果能尽量将一些潜在的问题最早的发现和解决,这样
整体系统的效率和可靠性就有了最大的保证。除了进行正常调用的测试,还要考虑异常调用的测试。除了要对自身模块进行测试,还要重视对相关模块的测试。
(7)掌握一些编程思想、设计模式,常用算法,这会让代码更加具有结构性、条理更加清晰、性能更高效。
(8)多看高手代码,读一些优秀的开源代码(如github,code project上源码),看经典书籍。
(9)开发完成后,多回顾以前代码,寻找能改进之处。
(10)遇到问题要多想几种解决的方案,鼓励多与团队成员交流,各人的思维方式不同、角度各异,各有高招。
(11)增强沟通能力,提升获取需求以及确认需求能力,保证所做功能是客户所需要的,避免不断返工。
(12)养成经常性的文档习惯。缺乏文档,一个软件系统就缺乏生命力,在未来的查错,升级以及模块的复用时就会遇到极大的麻烦。
(13)多在设计上下功夫,设计上的不足将会带来大量的重构与bug。多从全局的角度去考虑整个项目代码的架构、模块、层次等问题,追求最佳解决方案。
(14)有意识的就项目的组织和复用设计进行揣摩,培养模块化思维。
(15)不断总结和反思开发中遇到的问题及实现方案,并形成文档,鼓励与团队成员分享并交流。

三、解决方法(团队角度)
(1) 明确的编码规范要求
每个团队成员要严格遵守编码要求,编码规范要求中不确定因素要通过团队成员讨论形成,在Code Review中包含代码编写规范的审查。
(2) 实行正式的代码审查(Review)机制。
重要的模块项目组一起进行代码审查,团队成员通过向别人讲解自己的代码并得到反馈,能够学到很多东西。要求具体到每个技术细节,因为讨论的内容越具体,
在与别人的交流中获得有价值信息的可能性越大。
一般的功能模块可以让另一位成员进行代码审查,主要审查代码规范性,设计以及实现逻辑,并给出反馈和建议。
(3) 对重要问题的解决方案采用头脑风暴式讨论,倾向有理有据的讨论。
在明确问题背景后,对于不同解决方案进行讨论,比较不同解决方案优缺点,权衡利弊。
(4) 任务分配上,不要过于追求进度。好的代码质量需要好的设计、高效的算法选择,这些都需要时间作为保证。对于复杂问题,可以单独给员工一些时间
做设计、研究、分析,这样从长远来看是有价值的。
(5) 建立参与和分享的团队文化
尽可能地鼓励团队成员公开并分享他们的成果和想法,这会形成一个积极分享并乐于讨论问题的氛围,有利于提升团队人员整体水平。

 

posted on 2016-07-13 13:12  金木杂谈  阅读(1293)  评论(0编辑  收藏  举报