docs: 统一规范文档示例格式,使用三级标题 Example 和四级标题 Good/Bad 展示代码示例

This commit is contained in:
Lyda
2026-04-13 13:00:57 +08:00
parent dae54e90b6
commit f34b31f542
8 changed files with 141 additions and 71 deletions
+8 -4
View File
@@ -7,7 +7,9 @@
- 必须以 `.test.js``.test.ts`(或 `.spec.ts`)结尾。
- 前缀部分应与被测试源文件名保持一致。
### Good
### Example: 测试文件命名
#### Good: 测试文件名与源文件名一致
```javascript
// userInfo.js
@@ -17,7 +19,7 @@ describe("UserInfo", () => {
});
```
### Bad
#### Bad: 测试文件名与源文件名不一致
```javascript
// userInfo.js
@@ -32,7 +34,9 @@ describe("userinfo", () => {
- 测试代码命名结构:`describe(文件名)` -> `describe(函数名/类名.方法名)` -> `it(场景描述)`
- 场景描述应使用 "should ..." 格式,描述预期行为。
### Good
### Example: 测试代码块命名
#### Good: 使用 describe(文件名) -> describe(函数名/类名.方法名) -> it(场景描述)
```javascript
// uUerInfo.js
@@ -68,7 +72,7 @@ describe("userInfo", () => {
});
```
### Bad
#### Bad: 缺少 describe(函数名/类名.方法名) 层级
```javascript
// userInfo.js