文件撰写及命名规范

一、数据库中文件的命名规范

第一，数据库内文件的命名统一采用小写纯英文，命名文件不止一个单词，则中间用下划线“_”隔开，如图1所示；

第二，中英文概念对等，保证理解文件内容后对文件英文命名；

第三，相关项目文件的设立，采用统一前缀开头，如图1下tt_XX文件，tt前缀表示项目代号；

第四，不能和MySQL数据库中的关键字重合。可参考网址：

MySQL常用关键字和函数及部分关键字使用场景 - ZZKZS - 博客园 (cnblogs.com)。

图1 文件名展示

• Yii框架常见组成部分

1.config：

包含应用程序的配置文件，如数据库配置、路由规则、应用组件等。

2.controllers：

存放控制器文件，负责处理用户请求并返回响应。控制器通常会调用模型和视图来生成响应。

3.models：

存放模型文件，负责与数据库交互并处理业务逻辑。模型通常包含应用程序的业务规则和数据验证逻辑。

4.views：

存放视图文件，负责生成用户界面的HTML代码。视图通常会接收来自控制器的数据，并将其呈现给用户。

5.components：

存放应用程序的组件类，通常是一些共享的功能或服务，比如自定义的工具类、业务逻辑类等。

6.runtime：

存放应用程序运行时生成的文件，如缓存文件、日志文件等。这个目录通常是可写的，确保框架能够正常工作。

7.web（或public）：

存放Web服务器访问的文件，包括入口文件（index.php）、静态资源（如CSS、JavaScript、图片等）。

8.assets：

存放通过Yii框架生成的资源文件，如CSS和JavaScript文件的合并和压缩文件。

9.migrations：

存放数据库迁移文件，用于管理数据库的版本和结构变更。

10.tests：

存放测试文件，用于编写单元测试和功能测试。

11.vendor：

存放通过Composer管理的第三方库和依赖项。

12.commands：

存放自定义的控制台命令，Yii允许你通过控制台运行一些特定的任务。

图2 框架部分展示