mirror of
https://github.com/motajs/template.git
synced 2026-11-01 14:14:30 +08:00
docs(test): require test scope comments
This commit is contained in:
1 parent
33966fb4dd
commit
4349e67669
7 files changed
+7
No files matched your search
@@ -82,6 +82,7 @@
|
||||
- 对于 jsDoc 注释,方法注释必须使用换行风格;对于成员 jsDoc 注释,除非注释较长需要换行,否则使用不换行的风格。
|
||||
- 代码中的注释必须包含价值,说明下一行为什么会出现,不得出现解释下一行代码等类型的无价值注释,如 `// 清空 Xxx` 就属于无价值注释。
|
||||
- jsDoc 注释应该包含主要信息,不允许假设其使用场景,非必要不使用符号或英文单词,注释的目的是让用户看完注释就立刻知道接口的用处,而不是给写代码的人看,不得为了注释的正确性而使用奇怪的语序。
|
||||
- 测试文件必须在文件顶部使用单行注释说明当前覆盖的测试内容,测试范围变化时同步更新,便于后续人工审查。
|
||||
|
||||
### 类型规范
|
||||
|
||||
|
||||
Reference in new issue
Block a user