鸿蒙Harmony通过命令行生成doc

正常的通过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也没问题

以上。

相关推荐
智塑未来16 小时前
鸿蒙游戏体验手册:四种能力从性能到玩法逐一解锁
游戏·华为·harmonyos
math_hongfan17 小时前
鸿蒙离线数据缓存高级架构:弱网预加载/离线数据优先级/同步冲突解决/上线后数据合并策略
学习·缓存·华为·架构·harmonyos·鸿蒙
math_hongfan20 小时前
鸿蒙企业级数据存储高级架构:从读写分离到冷热数据分层/归档策略/数据生命周期管理最佳实践
人工智能·学习·华为·架构·harmonyos·鸿蒙
math_hongfan1 天前
鸿蒙存储异常高级排查:文件损坏检测/数据恢复/读写失败重试/磁盘空间预警系统性根治方案
学习·华为·harmonyos·鸿蒙
lilian2331 天前
Harmony os 技术实战|拼豆制图10:把取消、解析失败和保存失败写成可恢复状态机
java·javascript·华为·harmonyos
2501_919749031 天前
华为鸿蒙美缝剂实用APP—小羊美缝
华为·harmonyos
2501_919749031 天前
华为鸿蒙积攒年度高光APP—小羊高光
华为·harmonyos
智塑未来1 天前
鸿蒙7碰一碰智感交互——碰哪儿传哪儿
华为·harmonyos
math_hongfan1 天前
鸿蒙存储碎片高级清理机制:数据库Vacuum/文件碎片整理/缓存过期清理/主动空间回收策略
jvm·数据库·学习·缓存·华为·harmonyos·鸿蒙
梦想不只是梦与想1 天前
鸿蒙UI测试框架:UITest
harmonyos·uitest·ui测试框架