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和ACCESS写聊天室(三)
Oct 09 PHP
PHP日期时间函数的高级应用技巧
May 16 PHP
php自动加载的两种实现方法
Jun 21 PHP
PHP之APC缓存详细介绍 apc模块安装
Jan 13 PHP
PHP链接MySQL的常用扩展函数
Oct 23 PHP
php带抄送和密件抄送的邮件发送方法
Mar 20 PHP
解决php的“It is not safe to rely on the system’s timezone settings”问题
Oct 08 PHP
PHP使用Redis替代文件存储Session的方法
Feb 15 PHP
PHP 断点续传实例详解
Nov 11 PHP
对php 判断http还是https,以及获得当前url的方法详解
Jan 15 PHP
PHPStudy下如何为Apache安装SSL证书的方法步骤
Jan 23 PHP
PHP后门隐藏的一些技巧总结
Nov 04 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运行出现Notice : Use of undefined constant 的完美解决方案分享
2012/03/05 PHP
PHP中加密解密函数与DES加密解密实例
2014/10/17 PHP
php使用pdo连接报错Connection failed SQLSTATE的解决方法
2014/12/15 PHP
静态的动态续篇之来点XML
2006/08/15 Javascript
一个报数游戏js版(约瑟夫环问题)
2010/08/05 Javascript
JavaScript 继承使用分析
2011/05/12 Javascript
基于jquery的多功能软键盘插件
2012/07/25 Javascript
javascript完美拖拽的实现方法
2013/09/29 Javascript
Checbox的操作含已选、未选及判断代码
2013/11/07 Javascript
获取当前点击按钮的id用this.id实现
2014/03/17 Javascript
jquery实现的代替传统checkbox样式插件
2015/06/19 Javascript
JS控制FileUpload的上传文件类型实例代码
2016/10/07 Javascript
BootStrap入门学习第一篇
2017/08/28 Javascript
vue在自定义组件中使用v-model进行数据绑定的方法
2019/03/25 Javascript
Vue路由管理器Vue-router的使用方法详解
2020/02/05 Javascript
vue中实现动态生成二维码的方法
2020/02/21 Javascript
Vue+elementUI实现多图片上传与回显功能(含回显后继续上传或删除)
2020/03/23 Javascript
使用Python编写一个简单的tic-tac-toe游戏的教程
2015/04/16 Python
PyQt5中多线程模块QThread使用方法的实现
2020/01/31 Python
pytorch模型存储的2种实现方法
2020/02/14 Python
Python爬虫实例——scrapy框架爬取拉勾网招聘信息
2020/07/14 Python
python如何实现word批量转HTML
2020/09/30 Python
浅析关于Keras的安装(pycharm)和初步理解
2020/10/23 Python
两种CSS3伪类选择器详细介绍
2013/12/24 HTML / CSS
详解CSS中iconfont的使用
2015/08/04 HTML / CSS
html5中的input新属性range使用记录
2014/09/05 HTML / CSS
Spartoo英国:欧洲最大的网上鞋店
2016/09/13 全球购物
什么时候用assert
2015/05/08 面试题
社区端午节活动方案
2014/01/28 职场文书
《长征》教学反思
2014/04/27 职场文书
社会学专业求职信
2014/07/17 职场文书
新闻学专业求职信
2014/07/28 职场文书
2014年文艺部工作总结
2014/11/17 职场文书
2019终止劳动合同协议书最新范本!
2019/07/09 职场文书
小学语文的各类谚语(70首)
2019/08/15 职场文书
Python OpenGL基本配置方式
2022/05/20 Python