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 相关文章推荐
php 中include()与require()的对比
Oct 09 PHP
PHP 上传文件的方法(类)
Jul 30 PHP
PHP测试程序运行时间的类
Feb 05 PHP
php 模拟GMAIL,HOTMAIL(MSN),YAHOO,163,126邮箱登录的详细介绍
Jun 18 PHP
windows服务器中检测PHP SSL是否开启以及开启SSL的方法
Apr 25 PHP
PHP中使用循环实现的金字塔图形
Nov 08 PHP
Laravel SQL语句记录方式(推荐)
May 26 PHP
php中使用websocket详解
Sep 23 PHP
php微信公众号开发(4)php实现自定义关键字回复
Dec 15 PHP
Yii2-GridView 中让关联字段带搜索和排序功能示例
Jan 21 PHP
PHP获取数据库表中的数据插入新的表再原删除数据方法
Oct 12 PHP
PHP cookie与session会话基本用法实例分析
Nov 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面向对象全攻略 (十五) 多态的应用
2009/09/30 PHP
PHP读取文件内容的五种方式
2015/12/28 PHP
Laravel修改验证提示信息为中文的示例
2019/10/23 PHP
PHP ElasticSearch做搜索实例讲解
2020/02/05 PHP
Laravel服务容器绑定的几种方法总结
2020/06/14 PHP
自动更新作用
2006/10/08 Javascript
js 覆盖和重载 函数
2009/09/25 Javascript
JavaScript之appendChild、insertBefore和insertAfter使用说明
2010/12/30 Javascript
Javascript 面向对象(二)封装代码
2012/05/23 Javascript
JavaScript使用indexOf获得子字符串在字符串中位置的方法
2015/04/06 Javascript
Webpack 实现 Node.js 代码热替换
2015/10/22 Javascript
详解js图片轮播效果实现原理
2015/12/17 Javascript
js浏览器html5表单验证
2016/10/17 Javascript
BootStrap轮播HTML代码(推荐)
2016/12/10 Javascript
ES6学习之变量的解构赋值
2017/02/12 Javascript
vue 挂载路由到头部导航的方法
2017/11/13 Javascript
利用JS判断客户端类型你应该知道的四种方法
2017/12/22 Javascript
JS与SQL方式随机生成高强度密码示例
2018/12/29 Javascript
Vue表情输入组件 微信face表情组件
2019/02/11 Javascript
JQuery特殊效果和链式调用操作示例
2019/05/13 jQuery
vue-model实现简易计算器
2020/08/17 Javascript
js实现验证码干扰(静态)
2021/02/22 Javascript
Python计算一个给定时间点前一个月和后一个月第一天的方法
2018/05/29 Python
利用python GDAL库读写geotiff格式的遥感影像方法
2018/11/29 Python
python matplotlib库的基本使用
2020/09/23 Python
新西兰廉价汽车租赁:Snap Rentals
2018/09/14 全球购物
英国电气世界:Electrical World
2019/09/08 全球购物
C语言中一个结构不能包含指向自己的指针吗
2012/05/25 面试题
影视艺术学院毕业生自荐信
2013/11/13 职场文书
会计电算化应届生自荐信
2014/02/25 职场文书
槐乡的孩子教学反思
2014/04/27 职场文书
分公司经理任命书
2014/06/05 职场文书
植树造林的宣传标语
2014/06/23 职场文书
优质服务心得体会(共4篇)
2016/01/22 职场文书
用Python selenium实现淘宝抢单机器人
2021/06/18 Python
使用HBuilder制作一个简单的HTML5网页
2022/07/07 HTML / CSS