文件和目录命名
有意义的文件名/目录名英文名,不使用拼音,字母、数字、下划线.php结尾,驼峰命名
文件目录结构
使用规范的文件目录结构,利于维护性、扩展性
app:独立应用
class:单个的类文件,共用的类文件比如工具类;
conf/inc/config:配置文件类
data:数据文件目录
doc:程序相关的文档;
images:图片文件存放路径
css:css文件;
js:js文件
lib:共用类库。
template:模板文件
temp:临时文件目录;
upload:上传文件
类与接口命名
大写字母开头,各个单词首字母大写;类名和类文件保持一致;
程序中所有类名唯一;
接口命名规则:
1、与类名相同命名规则,在其命名前面加i表示接口。iDataBase.
2、尽量保持和实现它的类命名一致。iDatabase.interface.php
数据库命名
1、一律小写,表名使用统一的前缀,并且前缀不为空。多个单词使用下划线_间隔
2、表字段命名规则,有必要给字段加上前缀避免关键字和保留字。
3、存储过程proc_开头,触发器tri_开头,event调度以event_开头,视图view_开头
注释规范
每个程序必要注释,文件注释、代码块注释、函数注释
注释不宜太多,大家能看懂就行。
/**
*初始化过程
*@access public
*@return void
*/
文件注释:
放在整个PHP文件头部,文件版权、作者、编写日期、版本号、项目名称等重要信息。phpdocument规范。
类/接口注释
如果文件注释详细一般是不用类注释。大概描述类的用途
方法/函数注释
通常需要标明信息主要是可见性、参数类型和返回值类型
/**
* 数据库初始化 并取得数据库类实例
* @static
* @access public
* @param mixed $config 连接配置
* @param bool|string $name 连接标识 true 强制重新连接
* @return \think\db\Connection
* @throws Exception
*/
代码风格
缩进空格:4个空格做为缩进。
语句断行
尽量保证程序语句一行一句,不要使用一行太长控制80个字符。
未完待续…..