优化ArkUI无障碍Accessibility相关接口注释描述-interface

已关闭

优化ArkUI无障碍Accessibility相关接口注释描述 #25031

liuhui93创建于 6月23日关闭于 6月29日

liuhui93成员

6月23日创建

问题描述 / Description

ArkUI 无障碍（Accessibility）相关接口的注释描述不准确、不完整，存在以下问题：

AccessibilitySamePageMode、AccessibilityRoleType 等枚举的注释为简单英文短语，缺少规范的功能描述。
CommonMethod 中 accessibilityNextFocusId、accessibilityDefaultFocus、accessibilityDescription、accessibilityVirtualNode、accessibilityChecked、accessibilitySelected、accessibilityStateDescription、accessibilityActionOptions、accessibilityCustomActions 等方法的参数描述过于简略，未说明取值含义、默认值等信息。
UIInspector 类及 getUIInspector 方法的注释不符合规范。
多处 since 版本注解采用多段重复声明，应合并为规范格式。
超链接应统一使用 link 格式指向 SDK 接口，避免使用 .md 文件引用。

预期行为 / Expected Behavior

优化上述接口的注释，使描述准确、完整、符合 ArkUI 文档规范。

修改范围

涉及以下文件（中英文）：

api/@internal/component/ets/common.d.ts
api/@ohos.arkui.UIContext.d.ts
api/@ohos.arkui.UIContext.static.d.ets
api/arkui/component/common.static.d.ets
zh-cn/api/@internal/component/ets/common.d.ts
zh-cn/api/@ohos.arkui.UIContext.d.ts
zh-cn/api/@ohos.arkui.UIContext.static.d.ets

openharmony_ci成员

6月23日评论：

感谢提交Issue！关于Issue的交互操作，请访问OpenHarmony社区支持命令清单。如果有问题，请联系 [@xiadengping20241118](https://gitcode.com/xiadengping20241118) 。如果需要调整订阅PR、Issue的变更状态，请访问链接。

Thanks for submitting the issue. For more commands, please visit OpenHarmony Command List. If you have any questions, please refer to committer gitcode for help. If you need to change the subscription of a Pull Request or Issue, please visit the link.

openharmony_ci成员

6月23日添加了label：waiting_for_assign

liuhui93成员

6月23日修改了issue 的描述

liuhui93成员

6月23日关联了pull request：docs(arkui): 优化Accessibility接口注释描述

liuhui93成员

6月26日关联了pull request：docs(arkui): 优化Accessibility接口注释描述（common公共SDK文件）

openharmony_ci成员

6月29日关闭了 issue

openharmony_ci成员

6月29日 issue状态由待办的改变为已完成