Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
7ac2b8b3
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看板
未验证
提交
7ac2b8b3
编写于
9月 07, 2022
作者:
G
gloria
提交者:
Gitee
9月 07, 2022
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
【OpenHarmony开源贡献者计划2022】ts-template.md 修改几处描述错误
Signed-off-by:
N
gloria
<
80926032@qq.com
>
上级
fdcce10c
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
4 addition
and
4 deletion
+4
-4
zh-cn/contribute/template/ts-template.md
zh-cn/contribute/template/ts-template.md
+4
-4
未找到文件。
zh-cn/contribute/template/ts-template.md
浏览文件 @
7ac2b8b3
...
...
@@ -15,9 +15,9 @@
| 9 | 权限说明 | 以二级标题的形式,标题名为“需要权限”
<br/>
1. 如果仅系统应用可申请,格式:
<br/>
ohos.permission.xxxx,仅系统应用可用。
<br/>
2. 如果该权限所有应用可申请,格式:
<br/>
ohos.permission.xxxx
<br/>
3. 如果该接口涉及多个权限,则采用“和、或”进行分割,格式:
<br/>
ohos.permission.A 和 ohos.permission.B
<br/>
ohos.permission.A 或 ohos.permission.B |
| 10 | @system api | 1. 如果某个模块全部接口均为system api,则在模块开头的版本说明下一行,增加:
<br/>
- 本模块接口为系统接口。
<br/>
2. 如果某个接口为system api,仅供OEM厂商使用,则需要在描述中增加:
<br/>
**系统接口:**
此接口为系统接口。 |
| 11 | 示例代码语言 | 所有的示例代码采用代码块的样式,并标记开发语言为ts,且在示例代码最开始添加注释
`// xxx.ets`
|
| 12 | 链接写法 | 格式:[链接文字]
\(
链接内容)
<br/>
跨文件夹链接:[指南]
\(\.\.
/../xxx/xxx.md),一个
`../`
表示上移一层文件夹。
<br/>
页面内链接:[接口A
<sup>
7+
</sup>
]
\(
#xxxa7),页面内链接和需要链接到的标题保持一致,全小写无特殊符号无标签。 |
| 12 | 链接写法 | 格式:[链接文字]
\(
链接内容)
<br/>
跨文件夹链接:[指南]
\(\.\.
/../xxx/xxx.md),一个
`../`
表示上移一层文件夹。
<br/>
页面内链接:[接口A
<sup>
7+
</sup>
]
\(
#xxxa7),页面内链接和需要链接到的标题保持一致,全小写无特殊符号
(-除外)
无标签。 |
下面进入具体每个
API
的写作。
下面进入具体每个
组件接口
的写作。
***
...
...
@@ -25,7 +25,7 @@
> *写作说明*
>
> 1. **文档标题**:作为文档标题,要求使用中文短语概括本组件功能;但如果部分概念使用英文更便于开发者理解,可以直接使用。如Button、S
il
der等。
> 1. **文档标题**:作为文档标题,要求使用中文短语概括本组件功能;但如果部分概念使用英文更便于开发者理解,可以直接使用。如Button、S
li
der等。
> 2. **标题层级**:文档标题为一级标题,使用`# `;其他字段如function、class、interface、enum、type为二级标题,使用`## `;class下的属性、function为三级标题,使用`### `。
> 3. **起始版本说明**:使用markdown的引用语法“>”对接口的起始版本进行说明,说明后需要换行。<br/>版本说明统一放在模块描述之后。一个模块只会有一个起始版本。<br/>采用标准句式:“本模块首批接口从API version x开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。”x需要修改为对应的版本号。
...
...
@@ -43,7 +43,7 @@
**举例1**
:Marquee
跑马灯组件,用于滚动展示一段单行文本,仅当文本内容宽度
朝国
跑马灯组件宽度时滚动。
跑马灯组件,用于滚动展示一段单行文本,仅当文本内容宽度
超过
跑马灯组件宽度时滚动。
**举例2**
:SideBarContainer
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录