SuperAPI AI 工具集

docs-check-zh-cn

编程与开发

查看项目

更新于 10-16 07:28

技能介绍

用途:对 OpenHarmony API 文档做质量检查,涵盖模板合规性、文档一致性、错误码覆盖与实现对齐;报告只列问题、影响与修复建议,不重复已合规内容。\n\n主要能力:先定位文档、接口声明与实现代码;运行 scripts/check_api_doc_consistency.py 做稳定可自动化的检查;读取模板提取写作要求;对脚本不可靠的部分做人工复核;必要时将文档与实现行为交叉核对。脚本覆盖 d.ts 标签与 @throws 解析、public/system 位置与链接方向、@syscap/@permission/@atomicservice/@systemapi 等结构化字段、章节与文档级错误码覆盖、-sys.md 命名与 Readme-CN.md 条目、错误码文档必需块、版本标记、页内与相对链接解析等。\n\n用法:输入含公开 API 文档路径、系统 API 文档路径、错误码文档路径、API 定义路径(通常在 /interface)、仓库根路径(可选)。默认先从工作区根解析 /docs,再 /interface;以 /docs/... 或 /interface/... 开头的路径按仓库根路径解释。脚本调用示例:python3 scripts/check_api_doc_consistency.py --api /path/to/file.d.ts --public-doc /path/to/public.md --system-doc /path/to/system.md --error-doc /path/to/error.md --readme-doc /path/to/Readme-CN.md --js-template /path/to/native-template.md --ts-template /path/to/ts-template.md --error-template /path/to/errorcodes-template.md(--readme-doc 与模板参数可选)。模板优先级为仓库内模板、外部链接、技能内置 references 模板;按接口类别选择 JS API、ArkTS 组件或错误码模板,不单凭文件名判断。\n\n适用场景:OpenHarmony 文档评审与提交前检查、错误码覆盖核查、文档与接口实现一致性核对。\n\n限制:找不到实现时需向用户询问正确仓库路径;部分语义与解释质量问题需人工复核;脚本规则字面量来自 scripts/doc_check_rules.json,模板变化时应先核对规则文件;@since 处理仅按动态 API 视角,static 相关标记当前检查器会忽略。输出为 Markdown 报告,含位置、问题、建议与可直接给出的修正文本。