以下是我个人的PHP编码规范,仅供参考,欢迎拍砖.
最后更新:2007-10-17
PHP文件夹/文件命名规范
-----------------------------------
[LIST]
为方便和兼容不同操作系统,PHP文件夹/文件名统一全部使用小写,需要时可用下划线.
类文件,取名方式: 功能.class.php 如 db_mysql.class.php
函数文件取名 功能.fun.inc.php 如 news.fun.inc.php
不能通过浏览器直接访问的php文件取名 **.inc.php 并记得在第一行加入如下限制代码
!defined('INIT_PHPV') && die('Denied');
[/LIST]
注意:以上规范,[I]不适用于[/I] 网上下载的类库文件.
常用的文件夹有:
[LIST=1]
admin /管理
images /图片
templates /模板
includes /包含文件,各种函数及类库
script /前台脚本和css
data /网站数据 此文件夹可写. 内有缓存文件,错误日志等
upload /上传文件夹
html /静态html目录
[/LIST] PHP代码书写规范
-------------------------
类名: 单词间首字母用大写,其它小写.如 class MySql {.... }
类中的方法命名规范同上.
函数命名:
驼峰形式.即首单词字母小写,其它大写如
function error ($msg) {...}
function sendMail ($email) {..}
变量也使用驼峰形式.如
$fileName = 'abc.txt';
sql语句则遵照标准写法
关键字大写,表名和字段名最好用``引起来.查询参数用单引号引起来 如
$DB->Query("SELECT * FROM `tablename' WHERE `uid'='1' "
;
if...else用法:
统一使用大括号,除非非常特殊的情况下,不能用 [U]endif;[/U]
大括号用法:
推荐用
function foo {
....
}
也可用
function foo
{
....
}
在PHP文件里,除了语言包\注释\配置文件,其它地方不能有中文.
所有文件,保存格式为UTF8
数据库命名规范
-------------------------
表名全小写,如果需要,用下划线隔开单词
字段名单词首字母大写
如: 表user字段UserName
全文完。哈哈。
