From 0cdeb5028022694a7132b88c2dc908b928bf0bf1 Mon Sep 17 00:00:00 2001 From: LiAn Date: Tue, 30 Aug 2022 09:11:21 +0000 Subject: [PATCH] update zh-cn/contribute/template/js-template.md. Signed-off-by: LiAn Signed-off-by: LiAn --- zh-cn/contribute/template/js-template.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/zh-cn/contribute/template/js-template.md b/zh-cn/contribute/template/js-template.md index c39308ccc6..a637bde7d0 100644 --- a/zh-cn/contribute/template/js-template.md +++ b/zh-cn/contribute/template/js-template.md @@ -34,11 +34,15 @@ 模块描述。此处对该模块的定义、功能、使用场景、使用建议进行描述，采用如下固定句式。 -*（模块介绍，可选）xxx是xxx。 +（模块介绍，可选）xxx是xxx。 + （功能描述，必选）xxx模块提供xxx能力，包括xxx、xxx等。——当模块名不够语义化时，推荐此句式。 + 或 本模块提供xxx能力，包括xxx、xxx等。——当模块名已经表达了清晰的语义时，推荐此句式。 + （使用场景，可选）当需要xxx时，使用本模块接口xxx。 -（使用建议或注意事项，可选）本模块接口可与xxx联合使用，以提升开发效率……。* + +（使用建议或注意事项，可选）本模块接口可与xxx联合使用，以提升开发效率……。 **举例1**：“后台任务管理模块”的模块描述示例 -- GitLab