浅析php与数据库代码开发规范

2015-01-24信息快讯网

以下是对php与数据库代码开发规范进行了简单的分析介绍。需要的朋友可以过来参考下

1、PHP中对各类变量内容的命名规范
 
(1)目录命名、文件命名、局部变量命名:
使用英文名词、动词,以下划线作为单词的分隔,所有字母均使用小写
目录:upload、templates、install、manage……
文件:index.php 、 register.php  、 config.php……
变量:$user , $pay_time , $pay_del_cont ……

(2)全局常量命名:
使用英文名词、动词,所有字母都使用大写,以下划线分隔每个单词
define( 'WEBSITE_NAME', '名称' );
define( 'WEBSITE_URL',  '地址' );
英文名词、动(3)数组变量命名:
词,以下划线作为分隔,所有字母均使用小写以array结束
$scope_array  = array();
$book_id_array = array();

(4)对象变量命名:
英文名词、动词,以下划线作为分隔,可以完整采用类名或是简化类名,但是必须明确知道是什么类,所有字母均使用小写,在变量后加上_obj

$user_obj   = new userAccount();
$pay_obj   = new payOrder();

(5)类的命名:
使用英文名词,以大写字母作为词的分隔,其他的字母均使用小写,名词的首个字母使用小写,不使用下划线

class userAccount{ ……}

(6)方法命名:
使用英文名词、动词,以下划线作为单词的分隔,所有字母均使用小写

  
class userAccount { 
 public $name_account=‘'; 
 function is_account_ok(){ 
  ... 
 } 
 function add_account(){ 
  ... 
 } 
} 


关于对象属性的命名同理!

2、PHP中函数、符号、运算写作规范
 (1)if语句大括号{}规则:
将大括号放置在关键词后方
使用IF语句尽量使用大括号
  
if ( $condition ){ 
 ... 
}else{ 
 … 
} 
 
(2)、switch规则
每个case块结束处必须加上break,而default总应该存在处理未知情况,例:
  
switch( $condition ){ 
 case 'user': 
  ... 
  break; 
 case 'type': 
  ... 
  break; 
 default: 
  ... 
  break; 
} 
 
(3)、声明定位规则
声明代码块需要对齐,且初次使用变量时需要初始化
$tableName = '';
$databaseObject = '';
尽量不使用以下方式,例:
$tableName;
$accuntName = '';
$databaseObject = '';

html的form表单各个元素名称与数据库字段尽量保持一致。
不要采用缺省方法测试非零值,必须显式测试,例:
if ( $name_pay_into != false ){
 ...
}else{
 ...
}

*尽可能使用单引号''而不是双引号"",在需要加入变量或是写sql语句除外。
*php文件中尽可能不出现html语句,如果实在无法解决尽量少用,考虑到模板的兼容性,
html文件中尽可能避免出现php语句。
*通常每个方法只执行一项逻辑动作事务,所以对它们的命名应该清楚的说明它们是做什么的:
用email_error_check()代替error_check()。

请注意命名不要与系统方法冲突。

3、PHP中各类注释规范
/**
*  分页预处理函数
*  sql SQL语句
*  page 当前页数
*  limit 每页显示的数量
*  maxs 查询总数
*/
function limit($sql,$page='0',$limit=10,$maxs=''){ }

//用户检测
if( $check_obj->username( $username ) == true ){ … }

$user_name = $_GET[user];  //获取用户信息

4、数据库设计与操作规范
 
数据库规范
数据库名称应该由概述项目内容的小写英文名词组成,以下划线分隔单词,
避免跨平台时可能出现的大小写错误。

数据表名称应该由物件对象名称的小写英文名词组成(尽可能对应系统中的业务类名称),以下划线分隔单词,避免跨平台时可能出现的大小写错误。

数据表的字段应避免使用varchar、text等不定长的类型,时间信息的字段使用int类型存储。
查询数据连接多表时各资源应该使用全名称,即tableName.fieldName,而不是fieldName。
SQL语句应尽可能符合ansi92标准,避免使用特定数据库对SQL语言的扩充特性。

php中使用getimagesize获取图片、flash等文件的尺寸信息实例
PHP include任意文件或URL介绍
php调用google接口生成二维码示例
php将字符串转化成date存入数据库的两种方式
php使用array_rand()函数从数组中随机选择一个或多个元素
php导出csv数据在浏览器中输出提供下载或保存到文件的示例
PHP数据库操作之基于Mysqli的数据库操作类库
通过dbi使用perl连接mysql数据库的方法
php使用curl和正则表达式抓取网页数据示例
免费的ip数据库淘宝IP地址库简介和PHP调用实例
codeigniter自带数据库类使用方法说明
PHP编程风格规范分享
PHP的PSR规范中文版
JoshChen_php新手进阶高手不可或缺的规范介绍
php中jpgraph类库的使用介绍
九个你必须知道而且又很好用的php函数和特点
怎样使用php与jquery设置和读取cookies
php读取图片内容并输出到浏览器的实现代码
php调用Google translate_tts api实现代码
利用php+mcDropdown实现文件路径可在下拉框选择
浅析Mysql 数据回滚错误的解决方法
奉献出一个封装的curl函数 便于调用(抓数据专用)
PHP仿博客园 个人博客(2) 数据库增添改删
PHP仿博客园 个人博客(1) 数据库与界面设计
解决php使用异步调用获取数据时出现(错误c00ce56e导致此项操作无法完成)
PHP以指定字段为索引返回数据库所取的数据数组
关于使用key/value数据库redis和TTSERVER的心得体会
关于PHPDocument 代码注释规范的总结
关于php操作mysql执行数据库查询的一些常用操作汇总
PHP编码规范的深入探讨
深入php之规范编程命名小结
©2014-2024 dbsqp.com