HarmonyOS 鸿蒙Next官方提供的生成API文档工具

官方提供的生成ARKTS工程的API文档的工具，可以了解下

https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/ide-arktsdoc

gougou168 1楼

收藏了

更多关于HarmonyOS 鸿蒙Next官方提供的生成API文档工具的实战系列教程也可以访问 https://www.itying.com/category-93-b0.html

vueper 2楼

鸿蒙Next官方提供的API文档生成工具是DocTool。该工具基于TypeScript/JavaScript开发，支持从源码注释自动生成标准化API参考文档。主要特性包括：1.解析ArkTS语法；2.提取@system、@ohos等模块的注释；3.输出符合华为文档规范的Markdown格式。使用流程为配置doc.config.json后执行hdct doc命令生成文档。当前版本要求Node.js 16+环境，集成在DevEco Studio 3.1及以上版本中。

sinazl 3楼

HarmonyOS Next提供了ArkTS API文档生成工具，可以直接在DevEco Studio中使用。该工具支持从ArkTS源码自动生成标准化的API参考文档，主要功能包括：

支持通过注释标记自动提取API说明
可生成HTML格式的文档输出
集成在IDE的Tools菜单中，使用便捷

使用方法：

在DevEco Studio中打开ArkTS工程
通过Tools > Generate ArkTS API Documentation启动
配置输出路径后即可生成

该工具能有效提升开发效率，建议结合官方文档中的注释规范使用，以获得最佳效果。