基本规范
2018-10-19 16:59 更新
需要遵守的编码规范
PSR-4依赖于自动加载,而自动加载又依赖项目目录结构。
为了更好的使用我们的自动加载机制,也为了代码的易读、规范化,作者简明扼要的讲一下在使用Idea框架时,必须要遵守的一些编码规范。
Lniux系统与Windows系统开发的区别
Windows不区分大小写,Linux严格区分大小写。
在默认情况下,我建议同学们注意编码规范,平时编码有个习惯,所有代码都严格区分大小写。
分隔符,Linux使用'
/
',Windows使用'/
'与'\
',所以我们统一使用'/
'或者使用PHP内置常量DIRECTORY_SEPARATOR
来表示
1. 目录和文件
- 目录全部小写,PHP文件(入口文件除外)使用帕斯卡(大驼峰)命名法。
- 静态文件命名无严格要求。
2.类的规范
类名使用使用帕斯卡(大驼峰)命名法。直接以后缀
.php
结尾,无需以使用xxx.class.php
结尾。所有控制器类无需继承控制器基类(因为框架没有定义基类),且控制器类必须放置在
应用目录/模块目录/controller
下面。
例:application/admin/controller/Common.php
<?php
namespace app\admin\controller;
class Common
{
}
- 所有模型类必须继承模型基类
\system\Model
,且模型类必须放置在应用目录/模块目录/model
下面。
例:application/admin/model/User.php
<?php
namespace app\admin\model;
use \system\Model;
class User extends Model
{
}
3.函数与方法(函数方法推荐小驼峰)
- 方法名使用小驼峰命名法或者以下划线“_”分隔
//PSR-2规范
public static function getName()
{
}
4.变量和常量(变量推荐下划线分割,与函数方法区分)
- 变量或参数使用骆驼命名法或者以下划线“_”分隔,
例如:
$user_name='张三';
$userName='张三';
- 常量必须全部大写,单词之间以下划线“_”分隔,
例如:
define('APP_NAME','bbs');
一个完整的模型类设计如下:
例:application/admin/model/User.php
<?php
namespace app\admin\model;
use system\Model;
class User extends Model
{
public function userList()
{
#code...
}
}
以上内容是否对您有帮助:
← 目录自定义
更多建议: