From 58788724881c3ab1c486bec93d033b6f5f6bfebb Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E5=8D=A2=E9=9F=AC?= <lutao31@huawei.com>
Date: Tue, 18 Oct 2022 08:07:12 +0000
Subject: [PATCH] fix by comments
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: 卢韬 <lutao31@huawei.com>
---
 .../reference/apis/js-apis-hichecker.md       | 188 ++++++++----------
 1 file changed, 85 insertions(+), 103 deletions(-)

diff --git a/zh-cn/application-dev/reference/apis/js-apis-hichecker.md b/zh-cn/application-dev/reference/apis/js-apis-hichecker.md
index 532c71eb97..e645bfa90f 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-hichecker.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-hichecker.md
@@ -26,12 +26,9 @@ import hichecker from '@ohos.hichecker';
 | RULE_THREAD_CHECK_SLOW_PROCESS     | bigint   | 检测规则，检测是否有耗时函数被调用。                   |
 | RULE_CHECK_ABILITY_CONNECTION_LEAK | bigint   | 检测规则，检测是否发生ability泄露。                    |
 
+## hichecker.addCheckRule<sup>9+</sup>
 
-## hichecker.addRule<sup>(deprecated)</sup>
-
-addRule(rule: bigint): void
-
-> **说明：** 从 API Version 9 开始废弃，建议使用[hichecker.addCheckRule](#hicheckeraddcheckrule9)替代。
+addCheckRule(rule: bigint): void
 
 添加一条或多条规则到系统，系统根据添加的规则进行检测或反馈。
 
@@ -46,19 +43,20 @@ addRule(rule: bigint): void
 **示例：**
 
 ```js
-// 添加一条规则
-hichecker.addRule(hichecker.RULE_CAUTION_PRINT_LOG);
-
-// 添加多条规则
-hichecker.addRule(
-          hichecker.RULE_CAUTION_PRINT_LOG | hichecker.RULE_CAUTION_TRIGGER_CRASH);
+try {
+    // 添加一条规则
+    hichecker.addCheckRule(hichecker.RULE_CAUTION_PRINT_LOG);}
+    // 添加多条规则
+    hichecker.addCheckRule(
+        hichecker.RULE_CAUTION_PRINT_LOG | hichecker.RULE_CAUTION_TRIGGER_CRASH);
+catch (err) {
+    console.error(`code: ${err.code}, message: ${err.message}`);
+}
 ```
 
-## hichecker.removeRule<sup>(deprecated)</sup>
-
-removeRule(rule: bigint): void
+## hichecker.removeCheckRule<sup>9+</sup>
 
-> **说明：** 从 API Version 9 开始废弃，建议使用[hichecker.removeCheckRule](#hicheckerremovecheckrule9)替代。
+removeCheckRule(rule: bigint): void
 
 删除一条或多条规则，删除的规则后续将不再生效。
 
@@ -73,43 +71,20 @@ removeRule(rule: bigint): void
 **示例：**
 
 ```js
-// 删除一条规则
-hichecker.removeRule(hichecker.RULE_CAUTION_PRINT_LOG);
-
-// 删除多条规则
-hichecker.removeRule(
-          hichecker.RULE_CAUTION_PRINT_LOG | hichecker.RULE_CAUTION_TRIGGER_CRASH);
-```
-
-## hichecker.getRule
-
-getRule(): bigint 
-
-获取当前线程规则、进程规则、告警规则的合集。
-
-**系统能力：** SystemCapability.HiviewDFX.HiChecker
-
-**返回值：**
-
-| 类型   | 说明                   |
-| ------ | ---------------------- |
-| bigint | 当前系统中添加的规则。 |
-
-**示例：**
-
-```js
-// 添加一条规则
-hichecker.addRule(hichecker.RULE_THREAD_CHECK_SLOW_PROCESS);
-
-// 获取已添加的规则
-hichecker.getRule();   // return 1n;
+try {
+    // 删除一条规则
+    hichecker.removeRule(hichecker.RULE_CAUTION_PRINT_LOG);
+    // 删除多条规则
+    hichecker.removeRule(
+        hichecker.RULE_CAUTION_PRINT_LOG | hichecker.RULE_CAUTION_TRIGGER_CRASH);
+catch (err) {
+    console.error(`code: ${err.code}, message: ${err.message}`);
+}
 ```
 
-## hichecker.contains<sup>(deprecated)</sup>
-
-contains(rule: bigint): boolean
+## hichecker.containsCheckRule<sup>9+</sup>
 
-> **说明：** 从 API Version 9 开始废弃，建议使用[hichecker.containsCheckRule](#hicheckercontainscheckrule9)替代。
+containsCheckRule(rule: bigint): boolean
 
 当前已添加的规则集中是否包含了某一个特定的规则，如果传入的规则级别为线程级别，则仅在当前线程中进行查询。
 
@@ -130,16 +105,23 @@ contains(rule: bigint): boolean
 **示例：**
 
 ```js
-// 添加一条规则
-hichecker.addRule(hichecker.RULE_THREAD_CHECK_SLOW_PROCESS);
+try {
+    // 添加一条规则
+    hichecker.addRule(hichecker.RULE_THREAD_CHECK_SLOW_PROCESS);
 
-// 查询是否包含
-hichecker.contains(hichecker.RULE_THREAD_CHECK_SLOW_PROCESS); // return true;
-hichecker.contains(hichecker.RULE_CAUTION_PRINT_LOG); // return false;
+    // 查询是否包含
+    hichecker.contains(hichecker.RULE_THREAD_CHECK_SLOW_PROCESS); // return true;
+    hichecker.contains(hichecker.RULE_CAUTION_PRINT_LOG); // return false;
+catch (err) {
+    console.error(`code: ${err.code}, message: ${err.message}`);
+}
 ```
-## hichecker.addCheckRule<sup>9+</sup>
 
-addCheckRule(rule: bigint): void
+## hichecker.addRule<sup>(deprecated)</sup>
+
+addRule(rule: bigint): void
+
+> **说明：** 从 API Version 9 开始废弃，建议使用[hichecker.addCheckRule](#hicheckeraddcheckrule9)替代。
 
 添加一条或多条规则到系统，系统根据添加的规则进行检测或反馈。
 
@@ -151,29 +133,22 @@ addCheckRule(rule: bigint): void
 | ------ | ------ | ---- | ---------------- |
 | rule   | bigint | 是   | 需要添加的规则。 |
 
-**错误码：**
-
-| 错误码ID | 错误信息（此处仅提供错误抛出的关键信息） |
-| -------- | ---------------------------------------- |
-| 401      | Invalid input parameter!                 |
-
 **示例：**
 
 ```js
-try {
-    // 添加一条规则
-    hichecker.addCheckRule(hichecker.RULE_CAUTION_PRINT_LOG);}
-    // 添加多条规则
-    hichecker.addCheckRule(
-        hichecker.RULE_CAUTION_PRINT_LOG | hichecker.RULE_CAUTION_TRIGGER_CRASH);
-catch (err) {
-    console.error(`code: ${err.code}, message: ${err.message}`);
-}
+// 添加一条规则
+hichecker.addRule(hichecker.RULE_CAUTION_PRINT_LOG);
+
+// 添加多条规则
+hichecker.addRule(
+          hichecker.RULE_CAUTION_PRINT_LOG | hichecker.RULE_CAUTION_TRIGGER_CRASH);
 ```
 
-## hichecker.removeCheckRule<sup>9+</sup>
+## hichecker.removeRule<sup>(deprecated)</sup>
 
-removeCheckRule(rule: bigint): void
+removeRule(rule: bigint): void
+
+> **说明：** 从 API Version 9 开始废弃，建议使用[hichecker.removeCheckRule](#hicheckerremovecheckrule9)替代。
 
 删除一条或多条规则，删除的规则后续将不再生效。
 
@@ -185,29 +160,46 @@ removeCheckRule(rule: bigint): void
 | ------ | ------ | ---- | ---------------- |
 | rule   | bigint | 是   | 需要删除的规则。 |
 
-**错误码：**
+**示例：**
+
+```js
+// 删除一条规则
+hichecker.removeRule(hichecker.RULE_CAUTION_PRINT_LOG);
+
+// 删除多条规则
+hichecker.removeRule(
+          hichecker.RULE_CAUTION_PRINT_LOG | hichecker.RULE_CAUTION_TRIGGER_CRASH);
+```
+
+## hichecker.getRule
+
+getRule(): bigint 
+
+获取当前线程规则、进程规则、告警规则的合集。
+
+**系统能力：** SystemCapability.HiviewDFX.HiChecker
 
-| 错误码ID | 错误信息（此处仅提供错误抛出的关键信息） |
-| -------- | ---------------------------------------- |
-| 401      | Invalid input parameter!                 |
+**返回值：**
+
+| 类型   | 说明                   |
+| ------ | ---------------------- |
+| bigint | 当前系统中添加的规则。 |
 
 **示例：**
 
 ```js
-try {
-    // 删除一条规则
-    hichecker.removeRule(hichecker.RULE_CAUTION_PRINT_LOG);
-    // 删除多条规则
-    hichecker.removeRule(
-        hichecker.RULE_CAUTION_PRINT_LOG | hichecker.RULE_CAUTION_TRIGGER_CRASH);
-catch (err) {
-    console.error(`code: ${err.code}, message: ${err.message}`);
-}
+// 添加一条规则
+hichecker.addRule(hichecker.RULE_THREAD_CHECK_SLOW_PROCESS);
+
+// 获取已添加的规则
+hichecker.getRule();   // return 1n;
 ```
 
-## hichecker.containsCheckRule<sup>9+</sup>
+## hichecker.contains<sup>(deprecated)</sup>
 
-containsCheckRule(rule: bigint): boolean
+contains(rule: bigint): boolean
+
+> **说明：** 从 API Version 9 开始废弃，建议使用[hichecker.containsCheckRule](#hicheckercontainscheckrule9)替代。
 
 当前已添加的规则集中是否包含了某一个特定的规则，如果传入的规则级别为线程级别，则仅在当前线程中进行查询。
 
@@ -225,23 +217,13 @@ containsCheckRule(rule: bigint): boolean
 | ------- | ---------------------------------------------------------- |
 | boolean | 查询结果，true&nbsp;表示规则已添加，false 表示规则未添加。 |
 
-**错误码：**
-
-| 错误码ID | 错误信息（此处仅提供错误抛出的关键信息） |
-| -------- | ---------------------------------------- |
-| 401      | Invalid input parameter!                 |
-
 **示例：**
 
 ```js
-try {
-    // 添加一条规则
-    hichecker.addRule(hichecker.RULE_THREAD_CHECK_SLOW_PROCESS);
+// 添加一条规则
+hichecker.addRule(hichecker.RULE_THREAD_CHECK_SLOW_PROCESS);
 
-    // 查询是否包含
-    hichecker.contains(hichecker.RULE_THREAD_CHECK_SLOW_PROCESS); // return true;
-    hichecker.contains(hichecker.RULE_CAUTION_PRINT_LOG); // return false;
-catch (err) {
-    console.error(`code: ${err.code}, message: ${err.message}`);
-}
+// 查询是否包含
+hichecker.contains(hichecker.RULE_THREAD_CHECK_SLOW_PROCESS); // return true;
+hichecker.contains(hichecker.RULE_CAUTION_PRINT_LOG); // return false;
 ```
\ No newline at end of file
-- 
GitLab