Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
15ecfb99
D
Docs
项目概览
OpenHarmony
/
Docs
1 年多 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
未验证
提交
15ecfb99
编写于
8月 04, 2023
作者:
葛
葛亚芳
提交者:
Gitee
8月 04, 2023
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
update zh-cn/contribute/template/ts-template.md.
Signed-off-by:
N
葛亚芳
<
geyafang@huawei.com
>
上级
7b06297e
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
1 addition
and
1 deletion
+1
-1
zh-cn/contribute/template/ts-template.md
zh-cn/contribute/template/ts-template.md
+1
-1
未找到文件。
zh-cn/contribute/template/ts-template.md
浏览文件 @
15ecfb99
...
@@ -6,7 +6,7 @@
...
@@ -6,7 +6,7 @@
| ---- | ----------- | ---------------------------------------- |
| ---- | ----------- | ---------------------------------------- |
| 1 | 客户化写作基本要求 |
**写作中,请变身开发者,对于开发者使用该组件时所需的使用场景、参数选取原则、开发建议/经验、示例等信息进行清晰描述,达到指导开发者顺利使用本组件进行开发的目标。**
|
| 1 | 客户化写作基本要求 |
**写作中,请变身开发者,对于开发者使用该组件时所需的使用场景、参数选取原则、开发建议/经验、示例等信息进行清晰描述,达到指导开发者顺利使用本组件进行开发的目标。**
|
| 2 | |
**所有的写作说明,在完成写作后,都要删除。**
|
| 2 | |
**所有的写作说明,在完成写作后,都要删除。**
|
| 3 | 上传路径 | markdown文件:docs/zh-cn/application-dev/reference/arkui-ts
<br>
图片路径:docs/zh-cn/application-dev/reference/arkui-ts/figures,并在markdown文件中通过路径
`![](figures/xxx.jpg)`
或
`![](figures/xxx.png)`
引用。 |
| 3 | 上传路径 | markdown文件:docs/zh-cn/application-dev/reference/arkui-ts
<br>
图片路径:docs/zh-cn/application-dev/reference/arkui-ts/figures,并在markdown文件中通过路径
\!
[]
\(
figures/xxx.jpg)或
\!
[]
\(
figures/xxx.png)
引用。 |
| 4 | 文件命名 | 一个d.ts对应一个组件文档,文件名称需包含组件所属类和组件名,格式为:
**ts-组件所属类名-组件名.md**
。
<br/>
示例:
<br/>
基础组件text,文件命名为:ts-basic-component-text.md
<br/>
容器组件list,文件命名为:js-container-component-list.md |
| 4 | 文件命名 | 一个d.ts对应一个组件文档,文件名称需包含组件所属类和组件名,格式为:
**ts-组件所属类名-组件名.md**
。
<br/>
示例:
<br/>
基础组件text,文件命名为:ts-basic-component-text.md
<br/>
容器组件list,文件命名为:js-container-component-list.md |
| 5 | 目录修改 | 新增文件,需要修改对应的Readme,即
`docs/zh-cn/application-dev/reference/arkui-ts/Readme-CN.md`
。 |
| 5 | 目录修改 | 新增文件,需要修改对应的Readme,即
`docs/zh-cn/application-dev/reference/arkui-ts/Readme-CN.md`
。 |
| 6 | 文档结构 | - 模块说明
<br/>
- 起始版本说明
<br/>
- 导入模块/使用说明
<br/>
- 权限说明
<br>
- 接口、属性、事件、对象、枚举、自定义类型
<br/>
描述顺序和代码保持一致,如果某些接口具有逻辑顺序,请注意排列。 |
| 6 | 文档结构 | - 模块说明
<br/>
- 起始版本说明
<br/>
- 导入模块/使用说明
<br/>
- 权限说明
<br>
- 接口、属性、事件、对象、枚举、自定义类型
<br/>
描述顺序和代码保持一致,如果某些接口具有逻辑顺序,请注意排列。 |
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录