企业🤖AI智能体构建引擎,智能编排和调试,一键部署,支持私有化部署方案 广告
## 命名规范 > 请理解并尽量遵循以下命名规范,可以减少在开发过程中出现不必要的错误。 `Air CMS`遵循`PSR-2`命名规范和`PSR-4`自动加载规范,并且注意如下规范: ### 目录和文件 * 普通目录使用蛇形命名,`app`下目录采用大驼峰命名; * 类库、函数文件统一以`.php`为后缀; * 类的文件名均以命名空间定义,并且命名空间的路径和类库文件所在路径一致; * 类(包含接口和Trait)文件采用大驼峰命名,其它文件采用蛇形命名; * 类名(包括接口和Trait)和文件名保持一致,统一采用大驼峰命名; ### 函数、变量和类、属性命名 * 函数及其中变量的命名使用蛇形命名,例如`get_client_ip`,`$user_name`; * 类的命名采用大驼峰命名,例如`User`、`UserType`; * 方法的命名使用小驼峰命名,例如`getUserName`; * 属性的命名使用小驼峰命名,例如`$tableName`、`$instance`; ### 常量和配置 * 常量以大写蛇形命名,例如`AIR_PATH`; * 配置参数以蛇形命名,例如`site_url`; ### 数据表和字段 * 数据表和字段采用蛇形命名,并注意字段名不要以下划线开头,例如`air_user`表和`user_name`字段,不建议使用驼峰和中文作为数据表及字段命名。 ## 文件放置规范 ### 模板放置规范 模板文件放在`public/templates/模板名`目录下,具体目录结构请查看[模板目录结构](模板目录结构.md) ### 插件放置规范 模板文件放在`public/plugins/插件名`目录下,具体目录结构请查看[插件目录结构](插件目录结构.md)