From 72a2a17eba74c3d0b98046ce84a0b3a462f90252 Mon Sep 17 00:00:00 2001 From: unanmed <1319491857@qq.com> Date: Wed, 9 Sep 2026 13:36:21 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E8=B0=83=E6=95=B4=E6=B5=8B=E8=AF=95?= =?UTF-8?q?=E6=B3=A8=E9=87=8A=E8=AF=B4=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- dev.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dev.md b/dev.md index 1338f1d..5f6a48f 100644 --- a/dev.md +++ b/dev.md @@ -82,7 +82,7 @@ - 对于 jsDoc 注释,方法注释必须使用换行风格;对于成员 jsDoc 注释,除非注释较长需要换行,否则使用不换行的风格。 - 代码中的注释必须包含价值,说明下一行为什么会出现,不得出现解释下一行代码等类型的无价值注释,如 `// 清空 Xxx` 就属于无价值注释。 - jsDoc 注释应该包含主要信息,不允许假设其使用场景,非必要不使用符号或英文单词,注释的目的是让用户看完注释就立刻知道接口的用处,而不是给写代码的人看,不得为了注释的正确性而使用奇怪的语序。 -- 测试文件必须在文件顶部使用单行注释说明当前覆盖的测试内容,测试范围变化时同步更新,便于后续人工审查。 +- 测试文件必须在文件的每个 it 调用前使用单行注释说明当前覆盖的测试内容,测试范围变化时同步更新,便于后续人工审查。 ### 类型规范