Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
b90da853
D
Docs
项目概览
OpenHarmony
/
Docs
接近 2 年 前同步成功
通知
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看板
未验证
提交
b90da853
编写于
7月 13, 2023
作者:
zyjhandsome
提交者:
Gitee
7月 13, 2023
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
update zh-cn/contribute/style-guide/style-guide-example-code-style.md.
Signed-off-by:
zyjhandsome
<
zyjhandsome@126.com
>
上级
85077e54
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
69 addition
and
1 deletion
+69
-1
zh-cn/contribute/style-guide/style-guide-example-code-style.md
.../contribute/style-guide/style-guide-example-code-style.md
+69
-1
未找到文件。
zh-cn/contribute/style-guide/style-guide-example-code-style.md
浏览文件 @
b90da853
...
...
@@ -15,6 +15,75 @@
API参考中,每个接口(包括方法和组件)均需要提供示例代码。如果多个API存在关联关系,则需要在一个场景化的代码示例中体现。
### 【规则】每个接口提供的示例代码中无须增加`try...catch...`
【描述】
在接口示例代码中,为了保持示例代码的简洁性和易读性,不需要为每个接口调用添加
`try...catch...`
语句来捕获异常。
示例代码主要用于演示如何正确地使用接口,并提供了正确的处理方式。添加异常处理代码可能会使示例代码变得冗长且难以理解。
【正例】
```
ts
// 正例1:
let
want
=
{
bundleName
:
'
com.example.myapplication
'
,
abilityName
:
'
EntryAbility
'
};
this
.
context
.
startAbility
(
want
)
.
then
(()
=>
{
// 执行正常业务
console
.
info
(
'
Succeeded in starting ability.
'
);
})
.
catch
((
err
)
=>
{
// 处理业务逻辑错误
console
.
error
(
`Failed to start ability. Code is
${
err
.
code
}
, message is
${
err
.
message
}
`
);
});
// 正例2:
let
pathDir
=
...;
// 应用文件路径
let
filePath
=
pathDir
+
'
/test.txt
'
;
let
str
=
fs
.
readTextSync
(
filePath
,
{
offset
:
1
,
length
:
3
});
console
.
info
(
`Succeed in reading text, str is
${
str
}
`
);
```
【反例】
```
ts
// 反例1:
let
want
=
{
bundleName
:
'
com.example.myapplication
'
,
abilityName
:
'
EntryAbility
'
};
try
{
this
.
context
.
startAbility
(
want
)
.
then
(()
=>
{
// 执行正常业务
console
.
info
(
'
Succeeded in starting ability.
'
);
})
.
catch
((
err
)
=>
{
// 处理业务逻辑错误
console
.
error
(
`Failed to start ability. Code is
${
err
.
code
}
, message is
${
err
.
message
}
`
);
});
}
catch
(
err
)
{
// 处理入参错误异常
console
.
error
(
`Failed to start ability. Code is
${
err
.
code
}
, message is
${
err
.
message
}
`
);
}
// 反例2:
let
pathDir
=
...;
// 应用文件路径
let
filePath
=
pathDir
+
'
/test.txt
'
;
try
{
let
str
=
fs
.
readTextSync
(
filePath
,
{
offset
:
1
,
length
:
3
});
console
.
info
(
`Succeed in reading text, str is
${
str
}
`
);
}
catch
(
err
)
{
console
.
error
(
`Failed to read text. Code is
${
err
.
code
}
, message is
${
err
.
message
}
`
);
}
```
### 【规则】示例代码中的变量需要包含定义、使用方法或者来源链接参考或者说明
【描述】
...
...
@@ -527,4 +596,3 @@ function createFile() {
fileio.closeSync(fileFD);
}
`
``
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录