DTapi教程:05.命名规范
发表:DESTOON模板堂(dtmoban.com)
发表时间:2019-10-11
作者命名规范
- DTapi统一使用开发者不带www的官方网址作为作者名称,这样可以起了保护版权和区别其它开发者避免同名目的;
- 如:dtapi.com 表示这是DTapi官方的目录
应用命名规范
- DTapi统一使用英文小写,长度在3至10位的目录名称作为应用的名称
- 应用名称尽量具备一定的可读性,可使用插件功能的简称拼音或英文单词橡缩写;
- 好的命名规范可以使后续维护更加方便;
model命名规范
- DTapi采用的是面向对像编程风格,每个应用我们都规定了逻辑程序在控制器中编写,与数据库有关的操作程序在model中编写;
- 这规定不是强制性的,但DTapi仍然建议大家这样编码;
- DTapi 应用model目录下每个php文件表示一个模型,命名中不需要含.class,直接使用如:index.php, user.php, admin.php
- 类名必须与文件保持一致,否则无法自动加载
- 例:
index.php
<?php namespace dtapp\demo\model class index{ } ?>
注意:模型名字尽量不要和控制器名称一样,要不会出现use 模型时报错
控制器命名规范
- 应用目录下的controller目录中一个文件即为一个控制器
- 控制器命名不用包含.class,直接使用如 index.php,user.php
- 控制器名尽量有意义,做到尽可能的描述控制器功能;
- 建议:如果插件功能复杂,文件较多,建议一个控制器绑定一个模型,如果小插件,数据库操作少的,可以多个控制器绑定一个模型。
- 控制器类名必须与文件保持一致,否则框架无法自动加载进指定控制器。
- 例:
index.php
<?php namespace dtapp\demo class index{ } ?>
模板命名规范
- 所有应用相关的模板必须放到tpl目录下
- 模板文件必须是 .htm 后缀
- 文件名尽量和控制相关
- DTapi官方建议是, 控制名_方法名.htm 的组合
- 例:user.htm user_edit.htm user_add.htm
扩展命名规范
- 如果在您的应用中需要用到第三方类库,请将下载的类文件按照扩展命名规范放入到ext目录下即可;
- ext目录下,一个文件即为一个扩展,如果扩展中还包含其它文件,请在ext下新同名目录,然后使用include或require 方法加载;
- 扩展命名不用包含.class,直接使用如 index.php,user.php
- 扩展名尽量有意义,做到尽可能的描述控制器功能;
其它说明
- css,js,图片文件统一放到skin目录
- 模板文件必须放到tpl目录
- 模板文件命名尽量和控制器同名或相关