没有合适的资源?快使用搜索试试~ 我知道了~
PHP开发规范_20120711V1r4-draft_quxianping_revision1
需积分: 0 0 下载量 14 浏览量
2022-08-08
23:24:34
上传
评论
收藏 61KB DOCX 举报
温馨提示
试读
22页
PHP开发规范_20120711V1r4-draft_quxianping_revision1
资源详情
资源评论
资源推荐
PHP 开发规范 美博雅 MEIBOYA
1
PHP 开发规范
公司
美博雅(MEIBOYA)
项目
美肤志(meifuzhi.com)
编者
曲显平
审核
赵楠
发布日期
2012-07-11
版本
V1r4
PHP 开发规范 美博雅 MEIBOYA
2
PHP 开发规范 .................................................................................................................................1
编码规范 ..................................................................................................................................4
一、 命名规则 .................................................................................................................................4
二、 格式化 .....................................................................................................................................6
三、 字符串引用 .............................................................................................................................8
四、 忠告 .........................................................................................................................................8
五、 注释 .........................................................................................................................................9
六、 其它 .......................................................................................................................................12
设计风格 ................................................................................................................................13
七、 类 ...........................................................................................................................................13
八、 函数或方法 ...........................................................................................................................13
九、 系统调用 ...............................................................................................................................13
十、 不要采用缺省方法测试非零值............................................................................................13
十一、 布尔逻辑类型 ...................................................................................................................14
十二、 避免嵌入式的赋值 ...........................................................................................................14
十三、 面向对象 ...........................................................................................................................14
代码范例 ................................................................................................................................14
数据库设计 ............................................................................................................................17
十四、 存储引擎 ...........................................................................................................................17
十五、 表设计 ...............................................................................................................................17
十六、 字段类型 ...........................................................................................................................18
PHP 开发规范 美博雅 MEIBOYA
3
十七、 SQL 编写............................................................................................................................18
十八、 查询方式 ...........................................................................................................................20
十九、 表规模 ...............................................................................................................................20
开发测试流程.........................................................................................................................20
二十、 开发 ...................................................................................................................................20
二十一、 测试...............................................................................................................................21
二十二、 上线...............................................................................................................................21
文档........................................................................................................................................22
二十三、 文档命名.......................................................................................................................22
PHP 开发规范 美博雅 MEIBOYA
4
编码规范
一、 命名规则
1. 名副其实
在为任何一个变量、函数、类命名前,首先要明确地想清楚它是做什么的,然后再为它
取一个直达其意的名字。如果在看到一个命名的五秒钟内,你还是想不起来它是做什么的话,
那么这个命名就是糟糕的;如果还需要查手册才能明白它的含义时,这个命名的糟糕程度就
与#$%^&&%*¥(*无异。
坏例子: $u = ….
好例子: $userName = ……
2. 变量名
(1) 统一使用驼峰式,首字母小写,例如:$fileName
(2) 如果是类的保护或私有变量,应在变量标记$后以(_)下划线开头,例如:$_fileName
(3) 全局常量或静态变量,一般使用全大写,(_)下划线分隔的命名方式,例如:
$FILE_NAME
3. 方法和函数名
(1) 类中的方法必须显示声明(public/private/protected)
(2) 统一使用驼峰式,首字母小写,例如:
function findByPrimaryKey()
(3) 通常每个方法和函数都是执行一个动作的,所以对它们以动宾结构进行命名会更清
楚 地 说 明 它 们 是 做 什 么 的 : 比 如 用 checkForErrors() 代 替 errorCheck() , 用
PHP 开发规范 美博雅 MEIBOYA
5
dumpDataToFile()代替 dataFile(),这么做也可以使功能和数据变得更易区分
常用动词参考定义:set、get、check、save、remove、create、update、find、open、close、
show、view、add、delete
(4) 保护或私有方法,总是以 _ 下划线开头,这样可以让人清楚地了解其作用域
例如:
class NameOneTwo
{
public function doIt() {
};
private function _handleError() {
};
}
4. 类名
(1) 统一使用驼峰式,首字母大写,例如:class DiaryFactory
(2) 类名应该是名词或名词短语, 如 Customer、WikiPage、Account,避免使用
Manager、Processor、Data 或 Info 这样不明含义的类名,类名也不应该是动词。
5. 缩写词
缩写词应该使用首字母大写,其余字母小写的方式来书写命名。
例如:使用 GetHtmlStatistics,而不是用 GetHTMLStatistics
6. 关键词
public、protected、private 这类关键词应统一使用小写
剩余21页未读,继续阅读
小埋妹妹
- 粉丝: 22
- 资源: 344
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功
评论0