51 lines
1.1 KiB
Markdown
51 lines
1.1 KiB
Markdown
|
---
|
||
|
|
name: shz-admin-page-naming
|
||
|
|
description: Naming convention for new page directories in shz-admin. Use when creating a new page folder under src/pages/.
|
||
|
|
---
|
||
|
|
|
||
|
|
# shz-admin 页面目录命名规范
|
||
|
|
|
||
|
|
新建页面时，文件夹命名遵循：**首单词首字母大写，其余字母全部小写**。
|
||
|
|
|
||
|
|
## 规则
|
||
|
|
|
||
|
|
```
|
||
|
|
src/pages/{PageName}/
|
||
|
|
```
|
||
|
|
|
||
|
|
- 第一个单词的首字母 **大写**
|
||
|
|
- 其余所有字母（包括后续单词）**小写**
|
||
|
|
- 不允许多个大写字母（驼峰）
|
||
|
|
- 多个单词直接连写，不用分隔符
|
||
|
|
|
||
|
|
## 示例
|
||
|
|
|
||
|
|
```
|
||
|
|
✅ Talentcollect ❌ TalentCollect
|
||
|
|
✅ Mobileusers ❌ MobileUsers
|
||
|
|
✅ Management ❌ ManagementList
|
||
|
|
✅ Jobfair ❌ JobFair
|
||
|
|
✅ Livemgmt ❌ LiveMgmt
|
||
|
|
✅ Usermgmt ❌ UserMgmt
|
||
|
|
```
|
||
|
|
|
||
|
|
## 目录结构
|
||
|
|
|
||
|
|
新建页面时的标准文件结构：
|
||
|
|
|
||
|
|
```
|
||
|
|
src/pages/{PageName}/
|
||
|
|
└── List/
|
||
|
|
└── index.tsx
|
||
|
|
```
|
||
|
|
|
||
|
|
如果页面有弹窗子组件，放在同级的 `components/` 下：
|
||
|
|
|
||
|
|
```
|
||
|
|
src/pages/{PageName}/
|
||
|
|
├── List/
|
||
|
|
│ └── index.tsx
|
||
|
|
└── components/
|
||
|
|
└── SomeModal.tsx
|
||
|
|
```
|