分享web开发知识

注册/登录|最近发布|今日推荐

主页 IT知识网页技术软件开发前端开发代码编程运营维护技术分享教程案例
当前位置:首页 > 网页技术

PHP编码规范

发布时间:2023-09-06 01:58责任编辑:沈小雨关键词:PHP

1.文件格式

  • 所有php文件使用完整的php标签,如<?php ?>
  • 纯php代码文件,末尾不需要写 ?>

2.文件和目录命名

  • 程序文件名和目录名均采用有意义的英文命名
  • 类统一采用:DemoTest.class.php
  • 接口统一采用:DemoTest.interface.php
  • 其他按照各自的方式:demoTest.{style}.php
  • 其他一些文件按照:demoTest.inc.php     zend/demo.lib.php

3.文件目录结构

  • app                          独立的应用
  • class                            单个的类文件,公用的类文件(比如工具类)
  • conf/inc                        配置文件目录
  • data                        数据文件目录
  • doc                               程序相关文档
  • htdocs                          document_root
  • images                          图片目录
  • css                                css文件
  • js                                   javascript文件
  • lib                                  共用类库
  • template                        模板文件
  • upload                           上传文件
  • manage                        后台管理文件存放目录

4.命名规范

  • 程序整体以驼峰法命名,以小写字母开始(如:function displayName(){})
  • 全局变量键值两边都有"_",中间使用驼峰法命名(如:$_GLOBALE[‘_beginTime_‘])
  • 普通变量整体采用驼峰法,建议在变量前加表示类型的前缀,不确定类型的以大写字母开头(如:字符串->$sMyName    数组->$arrMyArray    对象->$oMyObject    资源->$resource    布尔值->$flag)
  • 函数名要有意义,尽量缩写,建议采用动词+形容词(如:showMsg)

5.类及接口命名

  • 以大写字母开头
  • 多单词,各个单词首字母大写
  • 接口命名加上i(如:iDataBase.interface.php)

6.数据库命名

  • 一律不出现大写
  • 数据表均使用小写,统一前缀,多单词以"_"间隔(如:blog_user_info)
  • 表字段全部小写命名,多单词以"_"间隔
  • 存储过程以proc_开头
  • 触发器以tri_开头
  • event调度以event_开头
  • 视图以view_开头

7.习惯与约定

  • 缩写(如Image->img   count->cnt)
  • 魔术数字,需要用数字时使用定义 define(TAX, 1.05)

8.注释规范

  • 程序注释,注释为什么这样做
  • 文件注释,表明作者,日期,功能
  • 方法和函数注释,解释参数含义

9.代码风格

  • 使用4个空格缩进
  • 等号两边要有空格
  • 一行一句,太长使用 .=拼接
  • 使用PHP_EOL

PHP编码规范

原文地址:https://www.cnblogs.com/kerwing/p/9150922.html

知识推荐

我的编程学习网——分享web前端后端开发技术知识。 垃圾信息处理邮箱 tousu563@163.com 网站地图
icp备案号 闽ICP备2023006418号-8 不良信息举报平台 互联网安全管理备案 Copyright 2023 www.wodecom.cn All Rights Reserved