chore: 将 JS/TS 文件命名规范文档移动至 back 目录进行归档

This commit is contained in:
Lyda
2026-05-19 18:08:44 +08:00
parent bb9c8bde5b
commit 76e53ce2a9
-55
View File
@@ -1,55 +0,0 @@
# 文件命名规范 `[JsTs.FileName]`
下面是 JS/TS 的文件命名规范.
## class 和 interface 文件命名规则 `[JsTs.FileName.ClassAndInterface]`
- 文件名必须与主导类或接口名称完全一致。
- 适用于定义单一主要实体的文件。
- 文件名使用大驼峰命名(如 `UserInfo.js`),或者使用短横线命名(如 `user-info.js`
### Example: class 和 interface 文件命名
#### Good: 使用大驼峰命名
```javascript
// UserInfo.js
class UserInfo {
// ...
}
```
#### Bad: 使用全小写命名
```javascript
// userinfo.js
class userinfo {
// ...
}
```
## 函数文件名规则 `[JsTs.FileName.FunName]`
- 适用于导出一个或多个工具函数的文件。
- 文件名应反映其包含的核心功能。
- 文件名使用小驼峰命名(如 `getUserInfo.js`),或者使用小写短横线命名(如 `get-user-info.js`
### Example: 函数文件命名
#### Good: 使用小驼峰命名
```javascript
// getUserInfo.js
function getUserInfo() {
// ...
}
```
#### Bad: 使用全小写命名
```javascript
// getuserinfo.js
function getuserinfo() {
// ...
}
```