From 1393b0348f45e0d2404a433afc48c965ec323ee4 Mon Sep 17 00:00:00 2001
From: liyufan <liyufan5@huawei.com>
Date: Mon, 27 Mar 2023 16:51:52 +0800
Subject: [PATCH] fix comment

Signed-off-by: liyufan <liyufan5@huawei.com>
---
 .../reference/apis/js-apis-net-mdns.md        | 141 ++++++++----------
 1 file changed, 59 insertions(+), 82 deletions(-)

diff --git a/zh-cn/application-dev/reference/apis/js-apis-net-mdns.md b/zh-cn/application-dev/reference/apis/js-apis-net-mdns.md
index 6e84f73574..b295831dd0 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-net-mdns.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-net-mdns.md
@@ -8,12 +8,12 @@ MDNS即多播DNS（Multicast DNS），提供局域网内的本地服务添加、
 ## 导入模块
 
 ```js
-import connection from '@ohos.net.mdns'
+import mdns from '@ohos.net.mdns'
 ```
 ## mdns.addLocalService
 
 function addLocalService(context: Context, serviceInfo: LocalServiceInfo,
-                         callback: AsyncCallback<LocalServiceInfo>): void;
+                         callback: AsyncCallback\<LocalServiceInfo>): void;
 
 添加一个mDNS服务，使用callback方式作为异步方法。
 
@@ -23,9 +23,9 @@ function addLocalService(context: Context, serviceInfo: LocalServiceInfo,
 
 | 参数名        | 类型                             | 必填 | 说明                                     |
 |-------------|----------------------------------|-----------|-------------------------------------------------|
-| context     | Context                          | 是       | 应用的上下文。 <br>FA模型的应用Context定义见[Context](js-apis-inner-app-context.md)。<br>Stage模型的应用Context定义见[Context](js-apis-inner-application-uiAbilityContext.md)。 |
-| serviceInfo | [LocalServiceInfo](#localserviceinfo)                 | 是        |   mDNS服务的信息      |
-| callback | AsyncCallback\<[LocalServiceInfo](#localserviceinfo)> | 是        |   回调函数。成功添加error为undefined，data为添加到本地的mdns服务信息      |
+| context     | Context                          | 是       | 应用的上下文。<br>Stage模型的应用Context定义见[Context](js-apis-inner-application-uiAbilityContext.md)。 |
+| serviceInfo | [LocalServiceInfo](#localserviceinfo)                 | 是        |   mDNS服务的信息。      |
+| callback | AsyncCallback\<[LocalServiceInfo](#localserviceinfo)> | 是        |   回调函数。成功添加error为undefined，data为添加到本地的mdns服务信息。      |
 
 **错误码：**
 
@@ -41,13 +41,9 @@ function addLocalService(context: Context, serviceInfo: LocalServiceInfo,
 **示例：**
 
 ```js
-import featureAbility from '@ohos.ability.featureAbility'
-
-// 获取context
-let context = featureAbility.getContext();
 let localServiceInfo = {
     serviceType: "_print._tcp",
-    serviceName: "into type",
+    serviceName: "servicename",
     port: 5555,
     host: {
         address: "10.14.**.***",
@@ -66,7 +62,7 @@ mdns.addLocalService(context, localServiceInfo, function (error, data) {
 
 ## mdns.addLocalService
 
-function addLocalService(context: Context, serviceInfo: LocalServiceInfo): Promise<LocalServiceInfo>;
+function addLocalService(context: Context, serviceInfo: LocalServiceInfo): Promise\<LocalServiceInfo>;
 
 添加一个mDNS服务，使用Promise方式作为异步方法。
 
@@ -76,7 +72,7 @@ function addLocalService(context: Context, serviceInfo: LocalServiceInfo): Promi
 
 | 参数名        | 类型                             | 必填 | 说明                                     |
 |-------------|----------------------------------|-----------|-------------------------------------------------|
-| context     | Context                          | 是       | 应用的上下文。 <br>FA模型的应用Context定义见[Context](js-apis-inner-app-context.md)。<br>Stage模型的应用Context定义见[Context](js-apis-inner-application-uiAbilityContext.md)。 |
+| context     | Context                          | 是       | 应用的上下文。<br>Stage模型的应用Context定义见[Context](js-apis-inner-application-uiAbilityContext.md)。 |
 | serviceInfo | [LocalServiceInfo](#localserviceinfo)                 | 是        |   mDNS服务的信息。      |
 
 **返回值：**
@@ -99,13 +95,9 @@ function addLocalService(context: Context, serviceInfo: LocalServiceInfo): Promi
 **示例：**
 
 ```js
-import featureAbility from '@ohos.ability.featureAbility'
-
-// 获取context
-let context = featureAbility.getContext();
 let localServiceInfo = {
     serviceType: "_print._tcp",
-    serviceName: "into type",
+    serviceName: "servicename",
     port: 5555,
     host: {
         address: "10.14.**.***",
@@ -124,7 +116,7 @@ mdns.addLocalService(context, localServiceInfo).then(function (data) {
 ## mdns.removeLocalService
 
 function removeLocalService(context: Context, serviceInfo: LocalServiceInfo,
-                            callback: AsyncCallback<LocalServiceInfo>): void;
+                            callback: AsyncCallback\<LocalServiceInfo>): void;
 
 移除一个mDNS服务，使用callback方式作为异步方法。
 
@@ -134,9 +126,9 @@ function removeLocalService(context: Context, serviceInfo: LocalServiceInfo,
 
 | 参数名        | 类型                             | 必填 | 说明                                     |
 |-------------|----------------------------------|-----------|-------------------------------------------------|
-| context     | Context                          | 是       | 应用的上下文。 <br>FA模型的应用Context定义见[Context](js-apis-inner-app-context.md)。<br>Stage模型的应用Context定义见[Context](js-apis-inner-application-uiAbilityContext.md)。 |
-| serviceInfo | [LocalServiceInfo](#localserviceinfo)                 | 是        |   mDNS服务的信息      |
-| callback | AsyncCallback\<[LocalServiceInfo](#localserviceinfo)> | 是        |   回调函数。成功移除error为undefined，data为移除本地的mdns服务信息      |
+| context     | Context                          | 是       | 应用的上下文。<br>Stage模型的应用Context定义见[Context](js-apis-inner-application-uiAbilityContext.md)。 |
+| serviceInfo | [LocalServiceInfo](#localserviceinfo)                 | 是        |   mDNS服务的信息。      |
+| callback | AsyncCallback\<[LocalServiceInfo](#localserviceinfo)> | 是        |   回调函数。成功移除error为undefined，data为移除本地的mdns服务信息。      |
 
 **错误码：**
 
@@ -152,13 +144,9 @@ function removeLocalService(context: Context, serviceInfo: LocalServiceInfo,
 **示例：**
 
 ```js
-import featureAbility from '@ohos.ability.featureAbility'
-
-// 获取context
-let context = featureAbility.getContext();
 let localServiceInfo = {
     serviceType: "_print._tcp",
-    serviceName: "into type",
+    serviceName: "servicename",
     port: 5555,
     host: {
         address: "10.14.**.***",
@@ -177,7 +165,7 @@ mdns.removeLocalService(context, localServiceInfo, function (error, data) {
 
 ## mdns.removeLocalService
 
-function removeLocalService(context: Context, serviceInfo: LocalServiceInfo): Promise<LocalServiceInfo>;
+function removeLocalService(context: Context, serviceInfo: LocalServiceInfo): Promise\<LocalServiceInfo>;
 
 移除一个mDNS服务. 使用Promise方式作为异步方法。
 
@@ -187,8 +175,8 @@ function removeLocalService(context: Context, serviceInfo: LocalServiceInfo): Pr
 
 | 参数名        | 类型                             | 必填 | 说明                                     |
 |-------------|----------------------------------|-----------|-------------------------------------------------|
-| context     | Context                          | 是       | 应用的上下文。 <br>FA模型的应用Context定义见[Context](js-apis-inner-app-context.md)。<br>Stage模型的应用Context定义见[Context](js-apis-inner-application-uiAbilityContext.md)。 |
-| serviceInfo | [LocalServiceInfo](#localserviceinfo)                 | 是        |   mDNS服务的信息      |
+| context     | Context                          | 是       | 应用的上下文。<br>Stage模型的应用Context定义见[Context](js-apis-inner-application-uiAbilityContext.md)。 |
+| serviceInfo | [LocalServiceInfo](#localserviceinfo)                 | 是        |   mDNS服务的信息。      |
 
 **返回值：**
 
@@ -210,13 +198,9 @@ function removeLocalService(context: Context, serviceInfo: LocalServiceInfo): Pr
 **示例：**
 
 ```js
-import featureAbility from '@ohos.ability.featureAbility'
-
-// 获取context
-let context = featureAbility.getContext();
 let localServiceInfo = {
     serviceType: "_print._tcp",
-    serviceName: "into type",
+    serviceName: "servicename",
     port: 5555,
     host: {
         address: "10.14.**.***",
@@ -236,7 +220,7 @@ mdns.removeLocalService(context, localServiceInfo).then(function (data) {
 
 function createDiscoveryService(context: Context, serviceType: string): DiscoveryService;
 
-返回一个DiscoveryService对象，该对象监听局域网内serviceType类型的LocalServiceInfo服务。
+返回一个DiscoveryService对象，该对象用于发现指定服务类型的mDNS服务。
 
 **系统能力**：SystemCapability.Communication.NetManager.MDNS
 
@@ -244,30 +228,27 @@ function createDiscoveryService(context: Context, serviceType: string): Discover
 
 | 参数名        | 类型                             | 必填 | 说明                                     |
 |-------------|---------|-----------| ------------------------------------------------------------ |
-| context     | Context                          | 是       | 应用的上下文。 <br>FA模型的应用Context定义见[Context](js-apis-inner-app-context.md)。<br>Stage模型的应用Context定义见[Context](js-apis-inner-application-uiAbilityContext.md)。 |
-| serviceType | string  | Yes       | 需要监听的mDNS服务类型。|
+| context     | Context                          | 是       | 应用的上下文。<br>Stage模型的应用Context定义见[Context](js-apis-inner-application-uiAbilityContext.md)。 |
+| serviceType | string  | Yes       | 需要发现的mDNS服务类型。|
 
 **返回值：**
 
 | Type                         | Description                     |
 | ----------------------------- |---------------------------------|
-| DiscoveryService | 基于指定serviceType和Context的发现服务。 |
+| DiscoveryService | 基于指定serviceType和Context的发现服务对象。 |
 
 **Example**
 
 ```js
-import featureAbility from '@ohos.ability.featureAbility'
-
-// 获取context
-let context = featureAbility.getContext();
 serviceType = "_print._tcp"
+
 let discoveryService = mdns.createDiscoveryService(context, serviceType);
 ```
 
 ## mdns.resolveLocalService
 
 function resolveLocalService(context: Context, serviceInfo: LocalServiceInfo,
-                             callback: AsyncCallback<LocalServiceInfo>): void;
+                             callback: AsyncCallback\<LocalServiceInfo>): void;
 
 解析一个mDNS服务，使用callback方式作为异步方法。
 
@@ -277,9 +258,9 @@ function resolveLocalService(context: Context, serviceInfo: LocalServiceInfo,
 
 | 参数名        | 类型                             | 必填 | 说明                                     |
 |-------------|----------------------------------|-----------|-------------------------------------------------------------|
-| context     | Context                          | 是       | 应用的上下文。 <br>FA模型的应用Context定义见[Context](js-apis-inner-app-context.md)。<br>Stage模型的应用Context定义见[Context](js-apis-inner-application-uiAbilityContext.md)。 |
-| serviceInfo | [LocalServiceInfo](#localserviceinfo)                 | 是        |   mDNS服务的信息      |
-| callback | AsyncCallback\<[LocalServiceInfo](#localserviceinfo)> | 是        |   回调函数。成功移除error为undefined，data为解析的mdns服务信息      |
+| context     | Context                          | 是       | 应用的上下文。<br>Stage模型的应用Context定义见[Context](js-apis-inner-application-uiAbilityContext.md)。 |
+| serviceInfo | [LocalServiceInfo](#localserviceinfo)                 | 是        |   mDNS服务的信息。      |
+| callback | AsyncCallback\<[LocalServiceInfo](#localserviceinfo)> | 是        |   回调函数。成功移除error为undefined，data为解析的mdns服务信息。      |
 
 **错误码：**
 
@@ -295,13 +276,9 @@ function resolveLocalService(context: Context, serviceInfo: LocalServiceInfo,
 **示例：**
 
 ```js
-import featureAbility from '@ohos.ability.featureAbility'
-
-// 获取context
-let context = featureAbility.getContext();
 let localServiceInfo = {
     serviceType: "_print._tcp",
-    serviceName: "into type",
+    serviceName: "servicename",
     port: 5555,
     host: {
         address: "10.14.**.***",
@@ -320,7 +297,7 @@ mdns.resolveLocalService(context, localServiceInfo, function (error, data) {
 
 ## mdns.resolveLocalService
 
-function resolveLocalService(context: Context, serviceInfo: LocalServiceInfo): Promise<LocalServiceInfo>;
+function resolveLocalService(context: Context, serviceInfo: LocalServiceInfo): Promise\<LocalServiceInfo>;
 
 解析一个mDNS服务，使用Promise方式作为异步方法。
 
@@ -330,8 +307,8 @@ function resolveLocalService(context: Context, serviceInfo: LocalServiceInfo): P
 
 | 参数名        | 类型                             | 必填 | 说明                                     |
 |-------------|--------------|-----------|-----------------------------------------------------|
-| context     | Context                          | 是       | 应用的上下文。 <br>FA模型的应用Context定义见[Context](js-apis-inner-app-context.md)。<br>Stage模型的应用Context定义见[Context](js-apis-inner-application-uiAbilityContext.md)。 |
-| serviceInfo | [LocalServiceInfo](#localserviceinfo)                 | 是        |   mDNS服务的信息      |
+| context     | Context                          | 是       | 应用的上下文。<br>Stage模型的应用Context定义见[Context](js-apis-inner-application-uiAbilityContext.md)。 |
+| serviceInfo | [LocalServiceInfo](#localserviceinfo)                 | 是        |   mDNS服务的信息。      |
 
 **返回值：**
 
@@ -353,13 +330,9 @@ function resolveLocalService(context: Context, serviceInfo: LocalServiceInfo): P
 **示例：**
 
 ```js
-import featureAbility from '@ohos.ability.featureAbility'
-
-// 获取context
-let context = featureAbility.getContext();
 let localServiceInfo = {
     serviceType: "_print._tcp",
-    serviceName: "into type",
+    serviceName: "servicename",
     port: 5555,
     host: {
         address: "10.14.**.***",
@@ -377,13 +350,13 @@ mdns.resolveLocalService(context, localServiceInfo).then(function (data){
 
 ## DiscoveryService
 
-基于指定serviceType和Context的发现服务。
+指定服务类型的发现服务对象。
 
 ### startSearchingMDNS
 
 startSearchingMDNS(): void
 
-开启监听指定服务类型的变化。
+开始搜索局域网内的mDNS服务。
 
 **系统能力**：SystemCapability.Communication.NetManager.MDNS
 
@@ -391,14 +364,14 @@ startSearchingMDNS(): void
 
 ```js
 let discoveryService = mdns.createDiscoveryService(context, serviceType);
-discoveryService.stopSearchingMDNS();
+discoveryService.startSearchingMDNS();
 ```
 
 ### stopSearchingMDNS
 
 stopSearchingMDNS(): void
 
-取消监听指定服务类型的变化。
+停止搜索局域网内的mDNS服务。
 
 **系统能力**：SystemCapability.Communication.NetManager.MDNS
 
@@ -422,14 +395,15 @@ on(type: 'discoveryStart',
 
 | 参数名        | 类型                             | 必填 | 说明                                     |
 |-------------|--------------|-----------|-----------------------------------------------------|
-| type     | string                          | 是       |订阅事件，固定为'discoveryStart'。<br>discoveryStart：开始监听本地服务事件。 |
-| callback | Callback<{serviceInfo: [LocalServiceInfo](#localserviceinfo), errorCode?: [MDNS_ERR](#mdns_err)}>                  | 是        |   mDNS服务的信息      |
+| type     | string                          | 是       |订阅事件，固定为'discoveryStart'。<br>discoveryStart：开始搜索局域网内的mDNS服务事件。 |
+| callback | Callback<{serviceInfo: [LocalServiceInfo](#localserviceinfo), errorCode?: [MDNS_ERR](#mdns_err)}>                  | 是        |   mDNS服务的信息和事件错误信息。      |
 
 **示例：**
 
 ```js
+// 参考mdns.createDiscoveryService
 let discoveryService = mdns.createDiscoveryService(context, serviceType);
-discoveryService.stopSearchingMDNS();
+discoveryService.startSearchingMDNS();
 
 discoveryService.on('discoveryStart', (data) => {
     console.log(JSON.stringify(data));
@@ -451,14 +425,15 @@ on(type: 'discoveryStop',
 
 | 参数名        | 类型                             | 必填 | 说明                                     |
 |-------------|--------------|-----------|-----------------------------------------------------|
-| type     | string                          | 是       |订阅事件，固定为'discoveryStop'。<br>discoveryStop：停止监听本地服务事件。 |
-| callback | Callback<{serviceInfo: [LocalServiceInfo](#localserviceinfo), errorCode?: [MDNS_ERR](#mdns_err)}>                 | 是        |   mDNS服务的信息      |
+| type     | string                          | 是       |订阅事件，固定为'discoveryStop'。<br>discoveryStop：停止搜索局域网内的mDNS服务事件。 |
+| callback | Callback<{serviceInfo: [LocalServiceInfo](#localserviceinfo), errorCode?: [MDNS_ERR](#mdns_err)}>                 | 是        |   mDNS服务的信息和事件错误信息。      |
 
 **示例：**
 
 ```js
+// 参考mdns.createDiscoveryService
 let discoveryService = mdns.createDiscoveryService(context, serviceType);
-discoveryService.stopSearchingMDNS();
+discoveryService.startSearchingMDNS();
 
 discoveryService.on('discoveryStop', (data) => {
     console.log(JSON.stringify(data));
@@ -479,14 +454,15 @@ on(type: 'serviceFound', callback: Callback<[LocalServiceInfo](#localserviceinfo
 
 | 参数名        | 类型                             | 必填 | 说明                                     |
 |-------------|--------------|-----------|-----------------------------------------------------|
-| type     | string                          | 是       |订阅事件，固定为'serviceFound'。<br>serviceFound：监听发现mDNS服务事件。 |
-| callback | Callback<[LocalServiceInfo](#localserviceinfo)>                 | 是        |   mDNS服务的信息      |
+| type     | string                          | 是       |订阅事件，固定为'serviceFound'。<br>serviceFound：发现mDNS服务事件。 |
+| callback | Callback<[LocalServiceInfo](#localserviceinfo)>                 | 是        |   mDNS服务的信息。      |
 
 **示例：**
 
 ```js
+// 参考mdns.createDiscoveryService
 let discoveryService = mdns.createDiscoveryService(context, serviceType);
-discoveryService.stopSearchingMDNS();
+discoveryService.startSearchingMDNS();
 
 discoveryService.on('serviceFound', (data) => {
     console.log(JSON.stringify(data));
@@ -507,14 +483,15 @@ on(type: 'serviceLost', callback: Callback<[LocalServiceInfo](#localserviceinfo)
 
 | 参数名        | 类型                             | 必填 | 说明                                     |
 |-------------|--------------|-----------|-----------------------------------------------------|
-| type     | string                          | 是       |订阅事件，固定为'serviceLost'。<br>serviceLost：监听移除本地服务事件。 |
-| callback | Callback<[LocalServiceInfo](#localserviceinfo)>   | 是        |   mDNS服务的信息      |
+| type     | string                          | 是       |订阅事件，固定为'serviceLost'。<br>serviceLost：移除mDNS服务事件。 |
+| callback | Callback<[LocalServiceInfo](#localserviceinfo)>   | 是        |   mDNS服务的信息。      |
 
 **示例：**
 
 ```js
+// 参考mdns.createDiscoveryService
 let discoveryService = mdns.createDiscoveryService(context, serviceType);
-discoveryService.stopSearchingMDNS();
+discoveryService.startSearchingMDNS();
 
 discoveryService.on('serviceLost', (data) => {
     console.log(JSON.stringify(data));
@@ -531,11 +508,11 @@ mDNS服务信息
 
 | 名称                  | 类型                                | 必填 | 说明                     |
 | --------------------- | ---------------------------------- | --- | ------------------------ |
-| serviceType   | string                             |  是 |  服务的类型。  |
-| serviceName | string                             |  是 |  m服务的名字。   |
-| port            | number           |  否 |  服务的端口号。           |
-| host           |  [NetAddress](js-apis-net-connection.md) |  否 |  mdns服务设备的IP地址。采用设备的IP，添加服务和移除服务时候不生效               |
-| serviceAttribute     | serviceAttribute\<[ServiceAttribute](#serviceattribute)> |  是 |  网络类型。               |
+| serviceType   | string                             |  是 |  mDNS服务的类型。格式_\<name>.<_tcp/_udp>，name长度小于63字符并且不能包含字符'.'。  |
+| serviceName | string                             |  是 |  mDNS服务的名字。   |
+| port            | number           |  否 |  mDNS服务的端口号。           |
+| host           |  [NetAddress](js-apis-net-connection.md) |  否 |  mDNS服务设备的IP地址。采用设备的IP，添加服务和移除服务时候不生效。               |
+| serviceAttribute     | serviceAttribute\<[ServiceAttribute](#serviceattribute)> |  是 |  mDNS服务属性信息。               |
 
 ## ServiceAttribute
 
@@ -545,7 +522,7 @@ mDNS服务属性信息
 
 | 名称                  | 类型                                | 必填 | 说明                     |
 | --------------------- | ---------------------------------- | --- | ------------------------ |
-| key   | string                             |  是 |  mDNS服务属性键值。  |
+| key   | string                             |  是 |  mDNS服务属性键值，键值长度应该小于9个字符。  |
 | value | Array<number>                             |  是 |  mDNS服务属性值。   |
 
 ## MDNS_ERR
@@ -558,4 +535,4 @@ mDNS错误信息。
 | --------------- | ---- | ----------- |
 | INTERNAL_ERROR  | 0    | 内部错误导致操作失败。  |
 | ALREADY_ACTIVE      | 1    | 服务已经存在导致操作失败。 |
-| MAX_LIMIT  | 2 | 请求超过最大限制导致操作失败。 |
\ No newline at end of file
+| MAX_LIMIT  | 2 | 请求超过最大限制导致操作失败。（暂不支持） |
\ No newline at end of file
-- 
GitLab