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 相关文章推荐
使用网络地址转换实现多服务器负载均衡
Oct 09 PHP
php返回json数据函数实例
Oct 09 PHP
php中spl_autoload详解
Oct 17 PHP
php中current、next与reset函数用法实例
Nov 17 PHP
php对文件进行hash运算的方法
Apr 03 PHP
分享PHP源码批量抓取远程网页图片并保存到本地的实现方法
Dec 01 PHP
WordPress中重置文章循环的rewind_posts()函数讲解
Jan 11 PHP
php gd等比例缩放压缩图片函数
Jun 12 PHP
yii2-GridView在开发中常用的功能及技巧总结
Jan 07 PHP
php中输出json对象的值(实现方法)
Mar 07 PHP
php微信公众号开发之秒杀
Oct 20 PHP
确保Laravel网站不会被嵌入到其他站点中的方法
Oct 18 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检测图片木马多进制编程实践
2013/04/11 PHP
深入解析WordPress中加载模板的get_template_part函数
2016/01/11 PHP
锋利的jQuery 要点归纳(二) jQuery中的DOM操作(下)
2010/03/23 Javascript
jQuery 技巧小结
2010/04/02 Javascript
Java 正则表达式学习总结和一些小例子
2012/09/13 Javascript
Js-$.extend扩展方法使方法参数更灵活
2013/01/15 Javascript
javascript 使用 NodeList需要注意的问题
2013/03/04 Javascript
jQuery页面图片伴随滚动条逐渐显示的小例子
2013/03/21 Javascript
js播放wav文件(源码)
2013/04/22 Javascript
jquery实现图片左右切换的方法
2015/05/07 Javascript
jQuery操作复选框(CheckBox)的取值赋值实现代码
2017/01/10 Javascript
js仿网易表单及时验证功能
2017/03/07 Javascript
js 客户端打印html 并且去掉页眉、页脚的实例
2017/11/03 Javascript
浅谈Vue render函数在ElementUi中的应用
2018/09/06 Javascript
如何根据业务封装自己的功能组件
2019/04/19 Javascript
layui问题之渲染数据表格时,仅出现10条数据的解决方法
2019/09/12 Javascript
js 根据对象数组中的属性进行排序实现代码
2019/09/12 Javascript
[01:53]3.19 DOTA2发布会 现场精彩Coser表演
2014/03/25 DOTA
python with提前退出遇到的坑与解决方案
2018/01/05 Python
小米5s微信跳一跳小程序python源码
2018/01/08 Python
python将txt文档每行内容循环插入数据库的方法
2018/12/28 Python
Python和Java的语法对比分析语法简洁上python的确完美胜出
2019/05/10 Python
Python获取一个用户名的组ID过程解析
2019/09/03 Python
tensorflow实现tensor中满足某一条件的数值取出组成新的tensor
2020/01/04 Python
python Canny边缘检测算法的实现
2020/04/24 Python
Django前后端分离csrf token获取方式
2020/12/25 Python
基于HTML5 Canvas的3D动态Chart图表的示例
2017/11/02 HTML / CSS
ToysRus日本官网:玩具反斗城
2018/09/08 全球购物
Vinatis德国:法国领先的葡萄酒邮购公司
2020/09/07 全球购物
土建工程师岗位职责
2014/06/10 职场文书
高中课前三分钟演讲稿
2014/09/13 职场文书
幼儿园老师新年寄语2015
2014/12/08 职场文书
开平碉楼导游词
2015/02/06 职场文书
工作会议通知
2015/04/15 职场文书
小学入学感言
2015/08/01 职场文书
六五普法学习心得体会
2016/01/21 职场文书