首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

如何在Jsdoc上保留源代码文件夹结构

在Jsdoc上保留源代码文件夹结构可以通过配置jsdoc的--recurse参数来实现。该参数会递归地处理指定文件夹下的所有文件,并保留文件夹结构。

以下是具体的步骤:

  1. 安装Jsdoc:首先,确保你已经安装了Node.js。然后,在命令行中运行以下命令来全局安装Jsdoc:
  2. 安装Jsdoc:首先,确保你已经安装了Node.js。然后,在命令行中运行以下命令来全局安装Jsdoc:
  3. 创建配置文件:在你的项目根目录下创建一个名为jsdoc.conf.json的配置文件,并添加以下内容:
  4. 创建配置文件:在你的项目根目录下创建一个名为jsdoc.conf.json的配置文件,并添加以下内容:
  5. 上述配置中,include指定了源代码文件夹的路径,这里假设源代码文件夹为srcexclude指定了需要排除的文件夹,这里排除了node_modules文件夹。destination指定了生成文档的目标文件夹,这里设为docs
  6. 生成文档:在命令行中运行以下命令来生成文档:
  7. 生成文档:在命令行中运行以下命令来生成文档:
  8. 运行上述命令后,Jsdoc会根据配置文件中的设置,递归处理src文件夹下的所有文件,并将生成的文档保存在docs文件夹中。

通过以上步骤,你可以在生成的文档中保留源代码文件夹结构。这样,你可以更清晰地查看每个文件的文档,并按照文件夹结构进行组织和导航。

注意:以上步骤是基于Jsdoc的默认模板生成文档的。如果你想使用其他模板或自定义模板,可以在配置文件中进行相应的设置。

页面内容是否对你有帮助?
有帮助
没帮助

相关·内容

没有搜到相关的视频

领券