浅析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语言的扩充特性。

赞 (0)

相关推荐

  • 讲的非常不错的PHP编码规范第1/3页

    注:这是从PHPCMS开发文档里看到编码规范,虽名为PHPCMS的开发规范,但我觉得所有的PHP编程都该如此.写了那么多PHP,很多编码对照这规范都感觉欠缺很多,今后一定要对照纠正. Phpcms 编码规范 1. 引言-. 2 2. 适用范围-. 2 3. 标准化的重要性和好处-. 3 4. PHP编码规范与原则-. 3 4.1. 代码标记- 3 4.2. 注释- 3 4.3. 书写规则- 4 4.3.1. 缩进- 4 4.3.2. 大括号{}.if和switch. 4 4.3.3. 运算符.小

  • php 注释规范

    @access 使用范围:class,function,var,define,module 该标记用于指明关键字的存取权限:private.public或proteced @author 指明作者 @copyright 使用范围:class,function,var,define,module,use 指明版权信息 @deprecated 使用范围:class,function,var,define,module,constent,global,include 指明不用或者废弃的关键字 @exa

  • 11个PHPer必须要了解的编程规范

    本文将讨论常用的良好的代码习惯,或者称为代码规范,在PHP领域. 1,错误报告开启 错误报告是在PHP中一个非常有用的功能,应同时在开发阶段启用. 这可以帮助我们确定我们的代码中的问题. 最常用的功能是"E_ALL",这有助于我们发现所有的警告和严重错误. 必须指出的是,我们把我们的代码投入上线前,我们应该关闭这个功能提示,否则会在浏览器上的暴漏所有潜在错误及警告. 2,使用DRY原则 'Do not Repeat Yourself',DRY原则指的是不要重复你的代码.. 这个概念是一

  • PHP编程风格规范分享

    说明:本规范由 EasyChen 借鉴 SINA网络应用开发部<C++开发规范>和互动技术部<PHP4开发规范>,以及phpDocument规范 整理出的开发规范.我觉得非常不错, 适合PHP的开发,给大家参考,养成一个良好的编程风格是非常有必要的. 第1章 命名规范 1.1变量 1.1.1全局变量 全局变量使用$g_开头,如$g_data_list. 1.1.2 一般变量 一般的变量使用小写字母命名,单词之间使用下划线分隔. 变量名字应该使用名词或者形容词+名词的方式.如$val

  • PHP的PSR规范中文版

    文档仓库地址:https://github.com/hfcorriez/fig-standards PSR规范中文版 PSR-0自动加载 PSR-1基本代码规范 PSR-2代码样式 PSR-3日志接口为何规范 摘录翻译了官方的一句话 本组织旨在通过讨论我们代码项目的共同点以找出一个协作编程的方法. 在此想到了一篇文章<Google为何要执行严格的代码规范>中有这么一段话: 复制代码 代码如下: 在谷歌,我可以查看任何的代码,进入所有谷歌的代码库,我有权查看它们.事实上,这种权限是很少人能拥有的

  • PHP文件注释标记及规范小结

    PHP 注释标记 @access 使用范围:class,function,var,define,module 该标记用于指明关键字的存取权限:private.public或proteced @author 指明作者 @copyright 使用范围:class,function,var,define,module,use 指明版权信息 @deprecated 使用范围:class,function,var,define,module,constent,global,include 指明不用或者废弃

  • PHP 代码规范小结

    命名规范 Θ 类文件都以.class.php为后缀,使用驼峰法命名,并且首字母大写,例如 Pay.class.php; Θ 类名和目录_文件名一致.例如:类名Zend_Autoloader的目录是Zend/Autoloader.class.php; Θ 函数的命名使用小写字母和下划线的方式.例如:get_client_ip; Θ 方法的命名使用驼峰法,首字母小写或者使用下划线"_",例如listComment(),_getResource(),通常下划线开头的方法属于私有方法; Θ 属

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

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

  • JAVA代码开发规范

    一.开发工具规范: 1. 开发工具经项目负责人调试后统一确定. 2. 开发工具一经确定不允许集成任何非统一插件,若有需要,经项目负责人同意后统一为 项目组成员添加. 3. 开发工具的编码格式不允许修改. 二.排版规范: 1. 关键词(或变量)和操作符之间加一个空格. 例如:int iCont = 1;//操作符和值之间有一个空格. 2. 相对独立的代码块与块之间加空行. 例如:两个方法之间需要用空格隔开. 3. 较长的语句.表达式等要分成多行书写. 4. 长表达式要在低优先级操作符处划分新行,操

  • 浅析PHP开发规范

    基本约定 源文件 代码使用<?php开头,忽略闭合标签?> 文件格式必须是无BOM UTF-8格式 一个文件只声明一种类型,如class和interface不能混写在一个源文件中 缩进 使用4个空格来缩进,IDE可以设置 行长度 每行120个字符 关键字 所有关键字均为小写,如true.false 命名 类名为大驼峰法,如UserModel 类方法名为小驼峰法,如getUserId() 函数使用小写字母加_组合,如get_cookie() 变量名使用小驼峰法,如$userId 常量定义为大写字

  • mysql数据库开发规范【推荐】

    最近一段时间一边在线上抓取SQL来优化,一边在整理这个开发规范,尽量减少新的问题SQL进入生产库.今天也是对公司的开发做了一次培训,PPT就不放上来了,里面有十来个生产SQL的案例.因为规范大部分还是具有通用性,所以也借鉴了像去哪儿和赶集的规范,但实际在撰写本文的过程中,每一条规范的背后无不是在工作中有参照的反面例子的.如果时间可以的话,会抽出一部分或分析其原理,或用案例证明. 一. 命名规范 1.库名.表名.字段名必须使用小写字母,并采用下划线分割 (1)MySQL有配置参数lower_cas

  • JavaScript开发规范要求(规范化代码)

    JavaScript开发规范要求(规范化代码)

    本人在开发工作中就曾与不按规范来开发的同事合作过,与他合作就不能用"愉快"来形容了.现在本人撰写此文的目的除了与大家分享一点点经验外,更多的是希望对未来的合作伙伴能够起到一定的借鉴作用.当然,如果我说的有不科学的地方还希望各路前辈多多指教.下面分条目列出各种规范要求,这些要求都是针对同事编码毛病提出来的,好些行业约定的其它规范可能不会再提及. 1.保证代码压缩后不出错 对于大型的JavaScript项目,一般会在产品发布时对项目包含的所有JavaScript文件进行压缩处理,比如可以利

  • PHP开发规范手册之PHP代码规范详解

    涉及多个方面,比如PHP代码规范.PHP文件命名规范.网站开发流程.网站安全与维护等.作为PHP开发规范的开篇,我从一个纯PHP开发者的角度来说说我所认为的PHP代码规范,主要从PHP目录框架结构.PHP代码书写规范.PHP文件命名规范三个角度来阐述,希望对PHP入门学习者有所帮助. 合理建设PHP目录框架结构 我们知道在使用PHP进行网站开发之前,我们需要建设网站的目录结构,网站目录框架结构设计得合理规范,不但有利于网站开发,而且对SEO,网站推广都有好处. 一般最基础的PHP网站结构涉及图片

  • J2EE项目代码编写规范分享

    码编写规范目的:能够在编码过程中实现规范化,为以后的程序开发中养成良好的行为习惯. 代码编写规范使用范围:J2EE项目开发. 包命名规范: 目的:包的命名规范应当体现出项目资源良好的划分 servlet类所在包命名规范:公司名称.开发组名称.项目名称.web.servlet 例如:net.linkcn.web.servlet 自定义标签类所在包命名规范:公司名称.开发组名称.项目名称.web.tags 例如:net.linkcn.web.tags 过滤器类所在包命名规范:公司名称.开发组名称.项

  • ORACLE数据库应用开发的三十个注意事项

    引言 笔者及所在团队从2000年开始的CRM等系统开发,一直主要使用ORACLE数据库作为应用数据库,开发方式包括使用PLSQL编写存储过程/数据库函数/触发器.使用ODBC或OCI和ProC开发C++应用.使用JDBC开发Java应用.使用tuxdeo开发中间件应用等.这些应用开发笔者所在团队自己做过,也委托华为.亚信.思特奇等国内厂商合作做过,整体来说ORACLE数据库功能强大.性能出众.系统健壮,确实是OLTP联机事务处理的最受欢迎的数据库. 因ORACLE服务费居高不下.加上最近几年美国

  • 阿里云官方Redis开发规范总结

    目录 一.键值设计 1. key 名设计 2. value 设计 3.[推荐]:控制 key 的生命周期,redis 不是垃圾桶. 二.命令使用 1.[推荐] O(N)命令关注 N 的数量 2.[推荐]:禁用命令 3.[推荐]合理使用 select 4.[推荐]使用批量操作提高效率 5.[建议]Redis 事务功能较弱,不建议过多使用 6.[建议]Redis 集群版本在使用 Lua 上有特殊要求: 7.[建议]必要情况下使用 monitor 命令时,要注意不要长时间使用. 三.客户端使用 1.[

  • Java代码注释规范详解

    Java代码注释规范详解

    代码附有注释对程序开发者来说非常重要,随着技术的发展,在项目开发过程中,必须要求程序员写好代码注释,这样有利于代码后续的编写和使用. 基本的要求: 1.注释形式统一 在整个应用程序中,使用具有一致的标点和结构的样式来构造注释.如果在其它项目中发现它们的注释规范与这份文档不同,按照这份规范写代码,不要试图在既成的规范系统中引入新的规范. 2.注释内容准确简洁 内容要简单.明了.含义准确,防止注释的多义性,错误的注释不但无益反而有害. 3.基本注释(必须加) (a) 类(接口)的注释 (b) 构造函

随机推荐