未验证 提交 1a4f9361 编写于 作者: O openharmony_ci 提交者: Gitee

!22385 【轻量级 PR】:add 示例代码场景说明

Merge pull request !22385 from zengyawen/N/A
...@@ -192,6 +192,10 @@ import call from '@ohos.telephony.call'; ...@@ -192,6 +192,10 @@ import call from '@ohos.telephony.call';
// 不允许直接写参数名,必须是可使用、易替代的实际用例。如果非用户自定义填写,需通过注释进行说明。 // 不允许直接写参数名,必须是可使用、易替代的实际用例。如果非用户自定义填写,需通过注释进行说明。
// 例如:var result = xxx.createExample(parameterOne); // parameterOne由扫描自动获取 // 例如:var result = xxx.createExample(parameterOne); // parameterOne由扫描自动获取
// 示例代码应提供常用场景示例,并通过注释说明示例会实现的效果。
// 样例:updateContact入参中,如果包含id,即更新某个联系人(常用场景),否则更新所有联系人。
// 示例代码中应提供常用场景,并告知用户该示例的效果。
// 注释要精简、突出要点。需提供注释的典型场景还有: // 注释要精简、突出要点。需提供注释的典型场景还有:
// 1. 当代码不能说明变量命名的具体含义,或不能说明代码逻辑时,必须提供注释。 // 1. 当代码不能说明变量命名的具体含义,或不能说明代码逻辑时,必须提供注释。
// 2. 涉及到复杂算法或特殊语法时,必须提供注释。 // 2. 涉及到复杂算法或特殊语法时,必须提供注释。
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册