Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
c5c3f349
D
Docs
项目概览
OpenHarmony
/
Docs
大约 2 年 前同步成功
通知
161
Star
293
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看板
未验证
提交
c5c3f349
编写于
10月 09, 2022
作者:
O
openharmony_ci
提交者:
Gitee
10月 09, 2022
浏览文件
操作
浏览文件
下载
差异文件
!10387 【轻量级 PR】:add zh-cn/contribute/template/errorcodes-template.md.
Merge pull request !10387 from LiAn/N/A
上级
0ad8a537
1ab9f681
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
120 addition
and
0 deletion
+120
-0
zh-cn/contribute/template/errorcodes-template.md
zh-cn/contribute/template/errorcodes-template.md
+120
-0
未找到文件。
zh-cn/contribute/template/errorcodes-template.md
0 → 100644
浏览文件 @
c5c3f349
# xxx *(子系统名)* 错误码
> **说明:**
>
> *1、所有的写作说明,在完成写作后,都要删除。*
>
> *2、错误码文档的命名规则:统一前缀,命名格式为errorcode-xxx(具体子系统名).md。*
| | 说明项 | 细则 |
| ---- | ------------------------------ | ------------------------------------------------------------ |
| 1 | 错误码error.errorNumber | 按统一的错误码编号规则设计错误码ID。 |
| 2 | 错误信息error.message |
**字段含义**
:出现异常时,会给开发者抛出一个错误对象,对象里包括errorNumber和error.message,此处定义error.message的值,即英文错误码简述。
<br/>
**要求**
:
<br/>
1.应当简洁、具体,避免过于宽泛的定义。
<br/>
2.此处英文描述必须经过翻译中心审校。在提交本错误码设计评审前,请将预期的中英文message描述提供给翻译中心,将翻译中心审校后的英文填至此处。 |
| 3 | 错误简述
<br/>
Short Description |
**字段含义**
:中文错误码简述。
<br/>
**要求**
:
<br/>
1.与”错误信息“对应的中文简述,应当简洁、具体,避免过于宽泛的定义。 |
| 4 | 错误描述
<br/>
Description |
**字段含义**
:错误码详细描述,告知错误码所属的业务场景、产生位置等。
<br/>
**要求**
:
<br/>
1.描述错误码所属的业务场景(比如开发xx业务、开发xx功能时)。
<br/>
2.描述出现异常的具体现象、产生位置(比如xx模块、xx类、xx接口等),辅助开发者理解和处理异常。 |
| 5 | 可能原因
<br/>
Possible Causes |
**字段含义**
:列举出现该异常的所有可能原因(对应该错误码的产生机制)。
<br/>
**要求**
:
<br/>
1.全面、无遗漏。
<br/>
2.言简意赅。
<br/>
3.根据可能性从高到低排序。 |
| 6 | 处理步骤
<br/>
Procedure |
**字段含义**
:根据错误现象及可能原因,告知开发者遇到该异常时如何应对。
<br/>
**要求**
:
<br/>
1.采用step样式描述处理指导。每个大步骤与可能原因一一对应,按顺序分别给出各原因对应的处理指导。大步骤下可以有子步骤。
<br/>
2.步骤要明确、具体、可执行。涉及判断的,提供明确的判断标准。
<br/>
3.对系统或业务有影响的操作,在操作前以“注意”或“警告”形式提供警示信息。具体提示要求,请参见“风格指南”中的“提示与说明”:https://gitee.com/openharmony/docs/blob/master/zh-cn/contribute/style-guide/style-guide-content-elements.md |
## 1300001 重复操作 *(错误码number+空格+错误简述)*
### 错误信息
This is repeat operation.
### 错误描述
> **说明:**
>
> *1.描述**错误码所属的业务场景(比如开发xx业务、开发xx功能时)***。
>
> *2.描述**出现异常的具体现象、产生位置(比如xx模块、xx类、xx接口等)**,辅助开发者理解和处理异常。*
当对同一窗口对象存在重复操作时,xx模块(或xx类,或xx接口)会上报此错误码。
### 可能原因
> **说明:**
>
> *列举出现该异常的所有可能原因(对应该错误码的产生机制)。*
>
> *1.全面、无遗漏。*
>
> *2.言简意赅。*
>
> *3.根据可能性从高到低排序。*
1.
重复创建已创建的窗口。
2.
xxx。
### 处理步骤
> **说明:**
>
> *根据错误现象及可能原因,告知开发者遇到该异常时如何应对。*
>
> *1.采用step样式描述处理指导。**每个大步骤与可能原因一一对应**,按顺序分别给出各原因对应的处理指导。**大步骤下可以有子步骤**。*
>
> *2.步骤要**明确、具体、可执行。涉及判断的,提供明确的判断标准**。*
>
> *3.对系统或业务有影响的操作,在操作前以“注意”或“警告”形式提供警示信息。具体提示要求,请参见“风格指南”中的“提示与说明”:https://gitee.com/openharmony/docs/blob/master/zh-cn/contribute/style-guide/style-guide-content-elements.md*
1.
检查该窗口是否已创建。
xxx。
```
uth([in] String appId, [in] IHwShareCallback callback);
int shareFaInfo([in] PacMapEx pacMapEx);
}
```
2.
xxx。
a. xxx。
```
uth([in] String appId, [in] IHwShareCallback callback);
int shareFaInfo([in] PacMapEx pacMapEx);
}
```
b. xxx。
## 1300002 窗口状态异常
### 错误信息
xxx
### 错误描述
xxx
### 可能原因
1.
xxx
### 处理步骤
1.
检查该窗口是否已创建。
xxx。
```
uth([in] String appId, [in] IHwShareCallback callback);
int shareFaInfo([in] PacMapEx pacMapEx);
}
```
2.
xxx。
a. xxx。
```
uth([in] String appId, [in] IHwShareCallback callback);
int shareFaInfo([in] PacMapEx pacMapEx);
}
```
b. xxx。
\ No newline at end of file
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录