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 相关文章推荐
如何给phpadmin一个保护
Oct 09 PHP
discuz7 phpMysql操作类
Jun 21 PHP
php中使用addslashes函数报错问题的解决方法
Feb 06 PHP
如何用php获取程序执行的时间
Jun 09 PHP
调试PHP程序的多种方法介绍
Nov 06 PHP
php将12小时制转换成24小时制的方法
Mar 31 PHP
PHP关联数组实现根据元素值删除元素的方法
Jun 26 PHP
PHP错误处理函数
Apr 03 PHP
[原创]PHP正则匹配中英文、数字及下划线的方法【用户名验证】
Aug 01 PHP
Laravel学习教程之View模块详解
Sep 18 PHP
PHP判断json格式是否正确的实现代码
Sep 20 PHP
laravel5表单唯一验证的实例代码
Sep 30 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获取post中的json数据的实现方法
2011/06/08 PHP
如何使用Linux的Crontab定时执行PHP脚本的方法
2011/12/19 PHP
php加密解密函数authcode的用法详细解析
2013/10/28 PHP
php中解析带中文字符的url函数分享
2015/01/20 PHP
实现PHP中session存储及删除变量
2018/10/15 PHP
jquery中focus()函数实现当对象获得焦点后自动把光标移到内容最后
2013/09/29 Javascript
在jquery中的ajax方法怎样通过JSONP进行远程调用
2014/04/04 Javascript
jfinal与bootstrap的登录跳转实战演习
2015/09/22 Javascript
利用Javascript仿Excel的数据透视分析功能
2016/09/07 Javascript
js实现hashtable的赋值、取值、遍历操作实例详解
2016/12/25 Javascript
JS判断一个数是否是水仙花数
2017/06/11 Javascript
纯JS实现只能输入数字的简单代码
2017/06/21 Javascript
分享ES6的7个实用技巧
2018/01/18 Javascript
详解Vue 全局引入bass.scss 处理方案
2018/03/26 Javascript
移动端如何用下拉刷新的方式实现上拉加载
2018/12/10 Javascript
关于better-scroll插件的无法滑动bug(2021通过插件解决)
2021/03/01 Javascript
python写的一个squid访问日志分析的小程序
2014/09/17 Python
介绍Python中的文档测试模块
2015/04/28 Python
Python OpenCV对本地视频文件进行分帧保存的实例
2019/01/08 Python
Form表单及django的form表单的补充
2019/07/25 Python
Django集成celery发送异步邮件实例
2019/12/17 Python
python绘制封闭多边形教程
2020/02/18 Python
如何实现在jupyter notebook中播放视频(不停地展示图片)
2020/04/23 Python
Python 跨.py文件调用自定义函数说明
2020/06/01 Python
收藏!10个免费高清视频素材网站!【设计、视频剪辑必备】
2021/03/18 杂记
Monnier Freres中文官网:法国领先的奢侈品配饰在线零售商
2017/11/01 全球购物
abstract class和interface有什么区别?
2012/01/03 面试题
业务总经理岗位职责
2014/02/03 职场文书
运动会邀请函范文
2014/02/06 职场文书
关工委先进个人事迹材料
2014/05/23 职场文书
拔河比赛口号
2014/06/10 职场文书
规范化管理年活动总结
2014/08/29 职场文书
创新社会管理心得体会
2014/09/12 职场文书
领导班子整改措施
2014/10/24 职场文书
Python利用机器学习算法实现垃圾邮件的识别
2021/06/28 Python
Win10 heic文件怎么打开 ? Win10 heic文件打开教程
2022/04/06 数码科技