鸿蒙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也没问题

以上。

相关推荐
二流小码农12 小时前
鸿蒙开发:router组件升级,彻底告别手动配置
android·ios·harmonyos
威哥爱编程21 小时前
模拟面试智能体开发实战 09:把面试官装进手机,鸿蒙端聊天界面用 SSE 流式输出让回复逐字滚出来
python·agent·harmonyos
威哥爱编程21 小时前
模拟面试智能体开发实战 10:配置写死在代码里还怎么换服务端,把设置和简历做成界面可配、可存
python·agent·harmonyos
Sirius_Ji2 天前
# 一份鸿蒙原生支持硬解的 ffmpeg 开发基座
harmonyos
贾伟康2 天前
HarmonyOS API 26 Navigation路由栈上限:stackSizeLimit、过载保护与容量观测
harmonyos·arkts·navigation·navpathstack·api26
江华森2 天前
把鸿蒙云手机调试的 5 个坑写成 Skill:12 项检查清单与报错决策树
harmonyos
木木子222 天前
用华为云码道构建校园导航应用「新生通」:从需求分析到工程落地
华为·华为云·harmonyos
贾伟康2 天前
HarmonyOS API 26 Navigation 自适应模式:mode、分栏切换与窗口断点治理
harmonyos·arkts·arkui·navigation·自适应布局
贾伟康2 天前
【转盘决定吧|07】HarmonyOS ArkTS 6.0.2.130 趣味题库:场景分类、随机选择与详情页解耦
harmonyos·arkts·路由·数据建模·arkui
贾伟康2 天前
【电路实验模拟|03】HarmonyOS ArkTS 交通灯实战:用定时状态切换红黄绿灯
harmonyos·arkts·canvas·arkui·交通灯