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 相关文章推荐
火车头discuz6.1 完美采集的php接口文件
Sep 13 PHP
php通过array_merge()函数合并两个数组的方法
Mar 18 PHP
百度地图API使用方法详解
Aug 25 PHP
PHP获取客户端及服务器端IP的封装类
Jul 21 PHP
php文件类型MIME对照表(比较全)
Oct 07 PHP
PHP二进制与字符串之间的相互转换教程
Oct 14 PHP
PHP文件系统管理(实例讲解)
Sep 19 PHP
php面向对象基础详解【星际争霸游戏案例】
Jan 23 PHP
PHP获取类私有属性的3种方法
Sep 10 PHP
php中get_object_vars()在数组的实例用法
Feb 22 PHP
PHP实现chrome表单请求数据转换为接口使用的json数据
Mar 04 PHP
如何用RabbitMQ和Swoole实现一个异步任务系统
May 29 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和ACCESS写聊天室(七)
2006/10/09 PHP
php生成二维码的几种方式整理及使用实例
2013/06/03 PHP
php中Socket创建与监听实现方法
2015/01/05 PHP
php基于双向循环队列实现历史记录的前进后退等功能
2015/08/08 PHP
PHP正则表达式匹配替换与分割功能实例浅析
2017/02/04 PHP
微信公众平台开发教程②微信端分享功能图文详解
2019/04/10 PHP
document.documentElement &amp;&amp; document.documentElement.scrollTop
2007/12/01 Javascript
JavaScript 字符串连接性能优化
2008/12/20 Javascript
jQuery 判断页面元素是否存在的代码
2009/08/14 Javascript
Ajax执行顺序流程及回调问题分析
2012/12/10 Javascript
Javascript 高阶函数使用介绍
2015/06/15 Javascript
jquery计算鼠标和指定元素之间距离的方法
2015/06/26 Javascript
jquery实现左右无缝轮播图
2020/07/31 Javascript
jQuery原理系列-常用Dom操作详解
2016/06/07 Javascript
JS如何设置cookie有效期为当天24点并弹出欢迎登陆界面
2016/08/04 Javascript
IE8兼容Jquery.validate.js的问题
2016/12/01 Javascript
详解Vue.js入门环境搭建
2017/03/17 Javascript
JavaScript设计模式之单例模式详解
2017/06/09 Javascript
JavaScript实现换肤功能
2017/09/15 Javascript
Vue2.0实现组件数据的双向绑定问题
2018/03/06 Javascript
JavaScript 高性能数组去重的方法
2018/09/20 Javascript
抖音上用记事本编写爱心小程序教程
2019/04/17 Javascript
VUE异步更新DOM - 用$nextTick解决DOM视图的问题
2020/11/06 Javascript
在Linux下调试Python代码的各种方法
2015/04/17 Python
Python运算符重载用法实例分析
2015/06/01 Python
Python中字典的setdefault()方法教程
2017/02/07 Python
amazeui 验证按钮扩展的实现
2020/08/21 HTML / CSS
营业经理岗位职责
2013/11/10 职场文书
《蒲公英》教学反思
2014/02/28 职场文书
一年级小学生评语
2014/04/22 职场文书
党的群众路线教育实践活动对照检查材料(四风)
2014/09/27 职场文书
2015年母亲节活动策划方案
2015/05/04 职场文书
nginx优化的六点方法
2021/03/31 Servers
MySQL 分组查询的优化方法
2021/05/12 MySQL
vue+iview实现手机号分段输入框
2022/03/25 Vue.js
《英雄联盟》2022日蚀、月蚀皮肤演示 黑潮亚索曝光
2022/04/13 其他游戏