docs: 统一规范文档示例格式,使用三级标题 Example 和四级标题 Good/Bad 展示代码示例
This commit is contained in:
@@ -7,7 +7,9 @@
|
||||
- 文件名必须与主导类或接口名称完全一致。
|
||||
- 适用于定义单一主要实体的文件。
|
||||
|
||||
### Good
|
||||
### Example: class 和 interface 文件命名
|
||||
|
||||
#### Good: 使用大驼峰命名
|
||||
|
||||
```javascript
|
||||
// UserInfo.js
|
||||
@@ -16,7 +18,7 @@ class UserInfo {
|
||||
}
|
||||
```
|
||||
|
||||
### Bad
|
||||
#### Bad: 使用全小写命名
|
||||
|
||||
```javascript
|
||||
// userinfo.js
|
||||
@@ -30,7 +32,9 @@ class userinfo {
|
||||
- 适用于导出一个或多个工具函数的文件。
|
||||
- 文件名应反映其包含的核心功能。
|
||||
|
||||
### Good
|
||||
### Example: 函数文件命名
|
||||
|
||||
#### Good: 使用小驼峰命名
|
||||
|
||||
```javascript
|
||||
// getUserInfo.js
|
||||
@@ -39,7 +43,7 @@ function getUserInfo() {
|
||||
}
|
||||
```
|
||||
|
||||
### Bad
|
||||
#### Bad: 使用全小写命名
|
||||
|
||||
```javascript
|
||||
// getuserinfo.js
|
||||
|
||||
Reference in New Issue
Block a user