未验证 提交 768de5c1 编写于 作者: L LiAn 提交者: Gitee

update zh-cn/contribute/template/ts-template.md.

Signed-off-by: LiAn <lian15@huawei.com> 
Signed-off-by: NLiAn <lian15@huawei.com>
上级 0cdeb502
......@@ -19,6 +19,8 @@
下面进入具体每个API的写作。
***
# 文档标题
> *写作说明*
......@@ -29,11 +31,15 @@
模块描述。此处对该模块的定义、功能、使用场景、使用建议进行描述,采用如下固定句式。
*(模块介绍,可选)xxx是xxx。。
(模块介绍,可选)xxx是xxx。
(功能描述,必选)提供xxx能力,包括xxx、xxx等。——当模块名不够语义化时,推荐此句式。
或 xxx组件/方法,用于xxx、xxx。——当模块名已经表达了清晰的语义时,推荐此句式。
(使用场景,可选)当需要xxx时,使用本模块xxx方法/本组件。
(使用建议或注意事项,可选)本模块可与xxx联合使用,以提升开发效率……。*
(使用建议或注意事项,可选)本模块可与xxx联合使用,以提升开发效率……。
**举例1**:Marquee
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册