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


Posted in PHP onJanuary 13, 2011

涉及多个方面,比如PHP代码规范、PHP文件命名规范、网站开发流程、网站安全与维护等。
作为PHP开发规范的开篇,我从一个纯PHP开发者的角度来说说我所认为的PHP代码规范,主要从PHP目录框架结构、PHP代码书写规范、PHP文件命名规范三个角度来阐述,希望对PHP入门学习者有所帮助。
合理建设PHP目录框架结构

我们知道在使用PHP进行网站开发之前,我们需要建设网站的目录结构,网站目录框架结构设计得合理规范,不但有利于网站开发,而且对SEO,网站推广都有好处。

一般最基础的PHP网站结构涉及图片、CSS文件、JS文件、第三方组件、管理后台等内容,相对应的,基础的PHP目录框架结构也涉及这些内容,这些目录命名时也有规范,比如

图片目录:images或者pic

CSS目录:css

JS目录:js

第三方组件目录:libs或者include,下一级目录可以根据具体的组件名定义目录名

管理目录:一般都是admin,单位了安全起见,你可以另起一个目录名或者对admin目录设置密码保护。如何对访问目录设置密码保护?

特别提醒:对于网站的框架目录结构,事先要做好规划,为了对搜索引擎友好便于网站推广,建议目录结构层次不要太深,二三级目录结构就可以了。

另外如果你采用模板,可以创建模板目录,比如将目录命名为tpl,如果使用第三方模板引擎,比如smarty,你可以根据需要自行决定是否要另设目录。PHP基础教程:Smarty安装教程

对于中等规模的网站,你也可以根据网站功能划分网站目录框架结构,比如按照频道等。

PHP文件命名规范

良好的PHP文件命名规范也是PHP开发规范的要素,有助于记忆,便于管理,PHP网站程序文件的命名也有一定的规则,比如

PHP网站首页文件命名规范:index.php或index.html

CSS文件命名规范:主CSS文件命名为style.css,另外你也可以针对具体的模块或者频道命名,比如用于用户的CSS文件,可以定义为user_style.css或者u_style.css

JS文件命名规范:主JS文件命名为main.js或major.js,其他的JS文件命名,你可以根据具体的页面或者特定的对象命名,比如首页JS文件可以命名为index.js,服务于用户登录的JS文件可以命名为user_login.js等。

网站配置文件命名规范:config.php或default_config.php等

文件命名特别提醒:在对PHP文件进行命名时考虑到可移植性,一律请使用小写命名,另外与网站目录名命名一样,文件命名时可以采用两种方式,一种可以使用拼音命名具体的文件,一种可以使用简单明了的英语单词命名文件,切勿随便命名,导致今后维护混乱。

PHP代码书写规范

良好的PHP代码规范,有助于PHP入门学习者从你写的PHP代码中受益,也有助于你今后的代码维护。

1、对于所写的PHP代码,添加必要的代码注释,同时代码注释要规范,更多基础PHP代码书写规范,请参考PHP基本语法教程

2、保持良好的PHP代码书写规范,合理使用缩进,保持代码美观。

3、使用赋值符时变量名、赋值符、值之间以空格分隔,即

<? 
$leapsoulcn = "欢迎访问PHP网站教程网,此节主要介绍PHP开发规范之PHP代码规范"; 
?>

4、在书写if、switch、函数代码时,务必保持大括号匹配,即
<? 
if(){ 
...... 
} 
?>

或者
<? 
if() 
{ 
...... 
} 
?>

5、命名变量名或者函数名时注意代码书写规范,可以使用拼音、英语单词、缩写等形式,推荐以英语单词作为PHP代码命名规范,对于两个单词以上的以下划线连接或者其中一个单词首字母大写的形式,即
<? 
$web_name = "PHP网站开发教程网"; 
$webUrl = "https://3water.com"; 
function userLogin() 
{ 
} 
?>

以上就是基础的PHP代码规范,对于PHP初学者学习PHP会有所帮助。养成良好的PHP代码规范会让开发者受益一生。

至此,PHP开发规范手册之PHP代码规范就介绍完了,良好的网站框架目录构建能力、PHP文件命名规范和PHP代码书写规范需要自己在不断的开发中积累和养成,同时这些开发规范也有助于伙伴之间的合作,有助于PHP入门学习者学习你的PHP代码。

PHP 相关文章推荐
玩转图像函数库―常见图形操作
Sep 03 PHP
用PHP实现小型站点广告管理(修正版)
Oct 09 PHP
PHP中开发XML应用程序之基础篇 添加节点 删除节点 查询节点 查询节
Jul 09 PHP
php+memcache实现的网站在线人数统计代码
Jul 04 PHP
PHP封装分页函数实现文本分页和数字分页
Oct 23 PHP
基于PHP实现通过照片获取ip地址
Apr 26 PHP
php项目开发中用到的快速排序算法分析
Jun 25 PHP
PHP GD库相关图像生成和处理函数小结
Sep 30 PHP
PHP生成word文档的三种实现方式
Nov 14 PHP
CodeIgniter框架验证码类库文件与用法示例
Mar 18 PHP
Laravel接收前端ajax传来的数据的实例代码
Jul 20 PHP
基于PHP实现栈数据结构和括号匹配算法示例
Aug 10 PHP
PHP JSON格式数据交互实例代码详解
Jan 13 #PHP
PHP学习笔记之二 php入门知识
Jan 12 #PHP
php算开始时间到过期时间的相隔的天数
Jan 12 #PHP
php数据库密码的找回的步骤
Jan 12 #PHP
重新封装zend_soap实现http连接安全认证的php代码
Jan 12 #PHP
php 变量未定义等错误的解决方法
Jan 12 #PHP
兼容性比较好的PHP生成缩略图的代码
Jan 12 #PHP
You might like
PHP 获取客户端真实IP地址多种方法小结
2010/05/15 PHP
一道关于php变量引用的面试题
2010/08/08 PHP
PHP设计模式(一)工厂模式Factory实例详解【创建型】
2020/05/02 PHP
《JavaScript高级程序设计》阅读笔记(一) ECMAScript基础
2012/02/27 Javascript
jquery实现图片灯箱明暗的遮罩效果
2013/11/15 Javascript
js在指定位置增加节点函数insertBefore()用法实例
2015/01/12 Javascript
JS函数修改html的元素内容,及修改属性内容的方法
2016/10/28 Javascript
javascript 定时器工作原理分析
2016/12/03 Javascript
使用vue.js编写蓝色拼图小游戏
2017/03/17 Javascript
B/S(Web)实时通讯解决方案分享
2017/04/06 Javascript
vue.js数据绑定的方法(单向、双向和一次性绑定)
2017/07/13 Javascript
JavaScript使用Ajax上传文件的示例代码
2017/08/10 Javascript
JS简单实现点击跳转登陆邮箱功能的方法
2017/10/31 Javascript
layer实现登录弹框,登录成功后关闭弹框并调用父窗口的例子
2019/09/11 Javascript
解决vue动态路由异步加载import组件,加载不到module的问题
2020/07/26 Javascript
python批量提交沙箱问题实例
2014/10/08 Python
python实现贪吃蛇小游戏
2020/03/21 Python
python找出因数与质因数的方法
2019/07/25 Python
python生成特定分布数的实例
2019/12/05 Python
tensorflow的ckpt及pb模型持久化方式及转化详解
2020/02/12 Python
Python装饰器用法与知识点小结
2020/03/09 Python
关于Python解包知识点总结
2020/05/05 Python
基于python实现把json数据转换成Excel表格
2020/05/07 Python
细说CSS3中的选择符
2008/10/17 HTML / CSS
鲜为人知的HTML5语音合成功能
2019/05/17 HTML / CSS
微软英国官方网站:Microsoft英国
2016/10/15 全球购物
党支部承诺书范文
2014/03/28 职场文书
环保建议书400字
2014/05/14 职场文书
2014党员民主评议个人思想剖析发言
2014/09/19 职场文书
学校党的群众路线教育实践活动对照检查材料
2014/09/24 职场文书
单位员工收入证明样本
2014/10/09 职场文书
经理岗位职责范本
2015/04/15 职场文书
工程服务质量承诺书
2015/04/29 职场文书
小学学习委员竞选稿
2015/11/20 职场文书
2019年销售部季度工作计划3篇
2019/10/09 职场文书
springboot 全局异常处理和统一响应对象的处理方式
2022/06/28 Java/Android