1.什么是不良代码?
代码逻辑难以被读懂理解
代码中要增加很多单行注释
代码逻辑存在低级BUG
存在冗余的代码
过多面向过程的代码
1)可读性
2)可扩展性
3)效率
下面就这三点开始来说,首先是可读性,通俗来讲,我们再项目中按照一写标准的语法、风格来开发软件,如果再解释代码逻辑时很容易讲清楚,讲明白,初步判断就是一篇可读性较好的代码。
使用通用的标准或自己定义一个风格。当同事接手你的工作,按照代码,风格以及文档注释就能够顺利工作,也是干净的好代码。在严谨的研发团队中,成员都要遵守通用的编码标准,当有新人加入团队中,可以有效缩短学习曲线和有效的减少开发成本。特别是产品第一版本完成开始迭代时,同事可能会接续你的工作,可读性和可扩展性的重要性就开始体现了,比如你使用的语言标准,为解决问题使用那些设计模式。如果你开发时遇到难题,设计了一个很好的解决方案,非常有必要在代码里说明,如何使用以及实现的逻辑。加上注释其他人就可以很快理解,就能实现他的价值,
可扩展性:可读性与可扩展性有助于代码的可维护性,使得在项目规划的时间内能快速迭代,软件开发过程中遵循一些可重复使用的,逻辑的,已知的设计模式,他是定义的标准设计模式或正常的逻辑流程,因此代码具备更大的可扩展性。
在便利数组时通常我们会用foreach语句,这已经是php编程的标准方法,但有的人会喜欢使用while或for这样的循环语句,除非特殊情况,我们实在不该使用这样的结构,避免不必要的混乱,造成可维护性不佳。
可扩展性的主要体现是去除耦合和封装,去除耦合意味着代码(主要是函数/方法和类)不相互依赖或相互重叠,而应该是‘纯粹’的功能实现,任何重叠的功能和其他非关联性实体都应该删除,我们正在写的函数逻辑,应该与他的命名相符,不能“挂羊头卖狗肉”,即不在函数内做额外的东西。
在编写代码时使用“工具箱”的方式————众多函数库共同打造大的复杂系统。
封装也是去除耦合的重要部分,要封装组件,就要从项目的范围抽取逻辑,并分离其内部的相互作用缩小在接口级别,这是一个通用模块化的方法,这样使得它更容易在以后的删除或更新系统的任何功能,使代码清晰。
效率:在开发过程中,我们应在通脑中时刻牢记“效率”二字,效率说开来即系统的“瓶颈”问题。因为在任何项目的代码中都有使用一些不合理的结构:例如嵌套循环和递归。还有一些不正确的处理逻辑,例如不使用缓存和发送/接收数据时没有适当的使用缓存。在互联网产品中,可读性和可扩展性不好导致的结果就是运行效率降低,大多数情况下,效率与这两个规则直接成正比。如果特殊的情况下确实需要使用递归,最好确保风险的规避,以及清晰的头脑,让自己的代码保持清晰干净。
1.代码文件是否相同编码风格(如PSR-1/2;
2.开发使用的是标准语法结构,不使用怪语法(由于php的灵活性,可能有多个样式都可以编写程序结构,在同一项目中要使用一种风格,避免不同的语法混在一起);
3.每个文件有一个标题,注释,记录其在项目中的角色
作为一项基本的要求,应该在每个程序文件中包括一个头与下面的注释:
1).应用程序的名称、版本和简要说明
2).文件到其他文件和包/组的从属关系
如下代码:
/**
* 与淘宝分销平台的商品同步
* =======================================================
* 版权所有2008——2014 思技创想(北京)科技有限公司,并保留所有权利。
* 网址:http://www.21cto.com
* --------------------------------------------------------
* 说明:
* 淘宝商品同步controller
* 放在crontab中运行*
* ======================================================
* @Author htt
* @copyright 2007_2014 Think Creative Technology Co.,Ltd
* @version Release:$Revision:17342$
* @license Commerce
* @Id: auto_product_sync_to_taobao.php 17342 2014-12-08 12:20:30 chris $
*/