鸿蒙Harmony通过命令行生成doc

时间:2025-02-14 19:26:28

正常的通过studio生成doc见:生成ArkTSDoc文档
本文主要讲述通过名命令行怎么执行(打包服务器为Linux,没安装studio),上述的能力在studio的build上不可见。

直接说结论

 node index.js -i 生成的文件 -w 工作空间 -s sdk路径 -d 文档输出目录

参数解释:
-i 文件目录 – 你想给那个文件夹或者模块生成,就写那个文件夹的路径
-w 工程目录 – 你整个项目的目录

遇到问题

1、index.js

这个文件在studio的位置为:DevEco Studio\plugins\openharmony\arktsdoc
你需要把它复制到Linux环境下,然后用全路径访问

2、文档输出目录

-d后面跟的这个目录需要先创建,再执行命令,否则会报找不到目录。不像studio那样会帮你自动创建。

3、执行成功但是没有内容

检查node版本,需要18以上,node最新的是18.20,我用的18.13.0也没问题

以上。