加入收藏 | 设为首页 | 会员中心 | 我要投稿 PHP编程网 - 钦州站长网 (https://www.0777zz.com/)- 科技、建站、经验、云计算、5G、大数据,站长网!
当前位置: 首页 > 站长学院 > PHP教程 > 正文

PHP编码规范暂行.doc

发布时间:2023-01-14 15:08:13 所属栏目:PHP教程 来源:
导读:  文档介绍:PHP编码规范

  文件结构

  文件结构和分类包括文件层次、命名含义等方面的约束,清晰的结构有助于源码的维护和理解。有意义的命名也是清晰结构的一个要素。比如config,一般就放系统配置文
  文档介绍:PHP编码规范
 
  文件结构
 
  文件结构和分类包括文件层次、命名含义等方面的约束,清晰的结构有助于源码的维护和理解。有意义的命名也是清晰结构的一个要素。比如config,一般就放系统配置文件。
 
  命名规范
 
  文件夹命名
 
  文件夹命名一般采PHP编码规范
 
  文件结构
 
  文件结构和分类包括文件层次、命名含义等方面的约束,清晰的结构有助于源码的维护和理解。有意义的命名也是清晰结构的一个要素。比如config,一般就放系统配置文件。
 
  命名规范
 
  文件夹命名
 
  文件夹命名一般采用小写英文字母,一般不超过20个字符,尽量言简意赅。常用的有images, inc, config, log, database, cache, upload等
 
  文件命名
 
  与文件夹类似,一般都采用小写英文字母。对于类文件,
 
  类名
 
  类文件是比较特殊的一类文件,类名是一个名词,可以反映出类的功能,一般采用小写英文字符(首字母大写),要尽量使你的类名简洁而又描述清楚,但避免使用不常见的缩写词。
 
  注意:类名一般与其文件名保持一致(但文件名全部小写),如:
 
  对应 EfrontEntity 对应 Cache
 
  函数命名
 
  函数、方法名是个动词,采用大小写英文字母结合方式命名,首字母小写,其余单词首字母大写。通常每个方法都是执行一个动作的,所以对它的命名应该说清楚是干什么的,比如function setName(),checkForms(), exportData(), getContent()等。
 
  常量
 
  常量命名应该全部大写,单词间用下划线隔开,以免混淆,比如MAX_WIDTH。
 
  常用的常量如状态、类型命名规则如下:
 
  STATUS_NORMAL(正常)、 STATUS_PAUSE(暂停)、 STATUS_DELETE(删除)
 
  TYPE_TEXT(文字)、 TYPE_PIC(图片)等
 
  变量
 
  变量命名方式与函数命名类似,采用大小写字母结合的方式。比如$adType
 
  变量名应简短且富于描述,尽量避免单个字符的变量名,除非是一次性的临时变量。临时变量通常被取名为i, j, m,nphp编码,它们一般用于整型。
 
  其他:
 
  (1)数组里面的key的value一律用k和v,如 foreach($arr as $k=>$v){}
 
  (2)循环处理数组的变量命名为 r,如foreach($planList as $r){}
 
  类变量
 
  类里面的变量申明规则:
 
  Public类型的遵循一般变量命名方式;
 
  Protected、private类型的变量一般用下划线开头,比如protected $_var;
 
  源文件编码规范
 
  引用
 
  当需要引入其他文件时,引入语句一般位于文件头部,并说明引入文件的作用,如:
 
  //数据库操作类
 
  require_once(‘’);
 
  申明
 
  一行一个申明,不要将不同类型变量的申明放在同一行内
 
  只在代码块的开始处声明变量,尽量在声明局部变量的同时初始化
 
  申明一个类的实例时,应该在类后面加括弧,如:
 
  $db = new Database; //错误,这是一种兼容php老版的做法,现在没必要
 
  $db = new
 

(编辑:PHP编程网 - 钦州站长网)

【声明】本站内容均来自网络,其相关言论仅代表作者个人观点,不代表本站立场。若无意侵犯到您的权利,请及时与联系站长删除相关内容!