PHP开发规范手册之PHP代码规范详解


涉及多个方面,比如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 = "http://www.phpstudy.net";
function userLogin()
{
}
?>

以上就是基础的PHP代码规范,对于PHP初学者学习PHP会有所帮助。养成良好的PHP代码规范会让开发者受益一生。
  至此,PHP开发规范手册之PHP代码规范就介绍完了,良好的网站框架目录构建能力、PHP文件命名规范和PHP代码书写规范需要自己在不断的开发中积累和养成,同时这些开发规范也有助于伙伴之间的合作,有助于PHP入门学习者学习你的PHP代码。



相关阅读:
设定sql server定期自动备份数据库
JavaScript 设计模式 安全沙箱模式
Asp.net(c#)数据库操作类
ASP的一些自定义函数整理
Apache+PHP+Zend的安装及配置
ASP获取ACCESS数据库表名及结构的代码
磁盘管理--pwd
ASP.NET缓存:方法分析和实践示例
[J2SE]Java中3DES加密解密调用示例
网页中经常用到的Metas, Links and DocTypes集合
JavaScript 简介
惠普本本如何改装xp系统
Asp.net MVC Beta 整合 Spring.Net
JSP漏洞大观
快速导航

Copyright © 2016 phpStudy |