【原文来自ibm development】
良好的编程习惯不仅能提高效率,还能让编写出在应用程序的整个生命周期中易于维护的代码;应用程序维护是一笔很大的开支。养成良好的编程习惯能够提高设计质量,从而使代码更加容易理解,因此维护就更加容易,同时也降低维护成本
- 使用良好的命名
- 语义化,就是看到名字就知道意思
- 通用前缀:is表示是否,后面跟形容词,如is_multilingual,而不是is_multilanguage;get表示读;set表示写
- 冗余后缀:尽量不要使用data、list、info后缀
- 类名:大写字母开头,驼峰命名;一般用名词,比如配置解析类:ConfigParser;这与java和C++一致
- 类的文件名:与类名一致。这与php autoload有关
- 非类文件名:全小写,下划线分隔,不得使用空格,比如get_user.php
- 目录名:全小写,下划线分隔,不得使用空格,如model、www、templates
- 函数名:小写字母开头,驼峰命名,例如:function addBlog()。这与C++和java类似
- 类中的函数:另个函数中间空一行
- URI定义
- 变量:全小写,下划线分隔
- 常量:全大写,下划线分隔
- php短标签
- 类的大括号后换行
- 分成更小的部分
- test
- 为代码添加注释
- 注释块
- @author yixun
- API注释
- 处理错误条件
- 根据大众的经验,如果编写健壮的应用程序,错误处理要遵循80/20规则:80%的代码用于处理异常和验证,20%的代码用于完成实际工作
- 在编写程序的基本逻辑代码时经常这样做。这意味着编写适用于基本条件荐的代码,及所有的数据都是可用的,所有条件符合预期
- 这个习惯要求我们编写足够的错误处理代码,而不是编写对付所有错误的代码,以致于diamante迟迟不能完成
- 切忌使用复制粘贴
- 我们可以从其他地方将代码复制粘贴到自己的代码编辑器,但是这样做有利也有弊
- 好的一面是,从一个实例或一个模板中复制代码能够避免很多错误
- 不好的一面是,这容易带来大量的类似编程方式
- 一定要注意,不要将代码从应用程序的一部分粘贴到另一部分。如果您在采用这种方式,请停止这个不良的习惯,然后考虑将这段代码重写为可重用的。
- 一般而言将代码放置到一个地方便于日后的维护,这样只需在一个地方那个更改代码
- 编写成带参数的可重用函数