reamde文件修正

This commit is contained in:
thinkphp
2016-06-23 17:08:12 +08:00
parent 5b061cd998
commit dc73254db3
2 changed files with 12 additions and 28 deletions

View File

@@ -39,12 +39,8 @@ ThinkPHP5在保持快速开发和大道至简的核心理念不变的同时PH
~~~
www WEB部署目录或者子目录
├─composer.json composer定义文件
├─README.md README文件
├─LICENSE.txt 授权说明文件
├─application 应用目录
│ ├─common 公共模块目录(可以更改)
│ ├─runtime 应用的运行时目录(可写,可定制)
│ ├─module_name 模块目录
│ │ ├─config.php 模块配置文件
│ │ ├─common.php 模块函数文件
@@ -53,6 +49,7 @@ www WEB部署目录或者子目录
│ │ ├─view 视图目录
│ │ └─ ... 更多类库目录
│ │
│ ├─command.php 命令行工具配置文件
│ ├─common.php 公共函数文件
│ ├─config.php 公共配置文件
│ ├─route.php 路由配置文件
@@ -60,6 +57,7 @@ www WEB部署目录或者子目录
├─public WEB目录对外访问目录
│ ├─index.php 入口文件
│ ├─router.php 快速测试文件
│ └─.htaccess 用于apache的重写
├─thinkphp 框架系统目录
@@ -68,17 +66,24 @@ www WEB部署目录或者子目录
│ │ ├─think Think类库包目录
│ │ └─traits 系统Trait目录
│ │
│ ├─mode 应用模式目录
│ ├─tpl 系统模板目录
│ ├─tests 单元测试文件目录
│ ├─base.php 基础定义文件
│ ├─classmap.php 核心类库映射列表文件
│ ├─console.php 控制台入口文件
│ ├─convention.php 框架惯例配置文件
│ ├─helper.php 助手函数文件
│ ├─phpunit.xml phpunit配置文件
│ └─start.php 框架入口文件
├─extend 扩展类库目录
├─runtime 应用的运行时目录(可写,可定制)
├─vendor 第三方类库目录Composer依赖库
├─build.php 自动生成定义文件(参考)
├─composer.json composer 定义文件
├─LICENSE.txt 授权说明文件
├─README.md README 文件
├─think 命令行入口文件
~~~
> router.php用于php自带webserver支持可用于快速测试
@@ -87,28 +92,7 @@ www WEB部署目录或者子目录
## 命名规范
ThinkPHP5的命名规范如下:
### 目录和文件
* 目录不强制规范,驼峰和小写+下划线模式均支持;
* 类库、函数文件统一以`.php`为后缀;
* 类的文件名均以命名空间定义,并且命名空间的路径和类库文件所在路径一致;
* 类名和类文件名保持一致,统一采用驼峰法命名(首字母大写);
### 函数和类、属性命名
* 类的命名采用驼峰法,并且首字母大写,例如 `User``UserType`不需要添加后缀例如UserController应该直接命名为User
* 函数的命名使用小写字母和下划线(小写字母开头)的方式,例如 `get_client_ip`
* 方法的命名使用驼峰法并且首字母小写或者使用下划线“_”例如 `getUserName``_parseType`,通常下划线开头的方法属于私有方法;
* 属性的命名使用驼峰法并且首字母小写或者使用下划线“_”例如 `tableName``_instance`,通常下划线开头的属性属于私有属性;
* 以双下划线“__”打头的函数或方法作为魔法方法例如 `__call``__autoload`
### 常量和配置
* 常量以大写字母和下划线命名,例如 `APP_DEBUG``APP_MODE`
* 配置参数以小写字母和下划线命名,例如 `url_route_on`
### 数据表和字段
* 数据表和字段采用小写加下划线方式命名,并注意字段名不要以下划线开头,例如 think_user 表和 user_name字段类似 _username 这样的数据表字段可能会被过滤。
ThinkPHP5的命名规范遵循PSR-2规范以及PSR-4自动加载规范。
## 参与开发
注册并登录 Github 帐号, fork 本项目并进行改动。