mirror of
https://gitee.com/ulthon/ulthon_admin.git
synced 2026-08-30 12:45:32 +08:00
1f91abe9d2
- AGENTS.md 工作流索引：补充 ulthon-update-workflow 与 ulthon-rules-manager，移除不存在的 ulthon-tools-log - ulthon-naming-convention.md：删除对 ulthon-source-directory.md 的错误引用，明确框架应用目录与控制器子目录命名规范 - ulthon-database-design.md / ulthon-scheme-definition：统一关联表 onlyFileds 键名说明，修正示例字段拼写 - ulthon-scheme-curd-workflow.md：CURD 表名参数表述与参数表对齐 - ulthon-permission-cli.md：章节改写为节点分配原则，去除变更痕迹叙事 - README.md：文档主页 URL 与 AGENTS.md 对齐
18 lines
1.2 KiB
Markdown
18 lines
1.2 KiB
Markdown
# 命名规范
|
||
|
||
## 目录命名
|
||
|
||
- 一个单词的目录用小写，例如 `service/`、`controller/`
|
||
- 多个单词的目录用大驼峰，例如独立的子项目目录 `AdminService/`、`UserService/`
|
||
- 此处的"多单词目录"指 **独立子项目目录**（如 `source/` 下各端工程、各子项目目录），**不**指框架标准应用目录
|
||
- 框架标准应用目录（`app/admin/`、`app/common/` 等）按 ThinkPHP 惯例统一使用小写
|
||
- **控制器子目录**：推荐使用全小写命名，例如 `app/admin/controller/system/`、`app/admin/controller/mall/`
|
||
- 即使目录名用了大驼峰，URL 也会自动转换，但默认全小写可避免歧义
|
||
- URL 访问规则详见 [ulthon-controller-url.md](./ulthon-controller-url.md)
|
||
|
||
## PHP 文件命名
|
||
|
||
- **service 模块**：文件名需要写 `Service` 后缀，例如 `AdminService.php`（类名 `AdminService`），而不是 `Admin.php`
|
||
- **其他模块**（controller、model、traits、config、middleware 等）：不需要写后缀，直接使用业务名（如 `User.php`、`Order.php`）
|
||
- **Scheme 类**：文件名采用大驼峰（PascalCase），且必须与类名一致，详见 [ulthon-scheme-definition](../skills/ulthon-scheme-definition/SKILL.md)
|