首页
学习
活动
专区
工具
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的默认模板生成文档的。如果你想使用其他模板或自定义模板,可以在配置文件中进行相应的设置。

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

相关·内容

我们如何为 JavaScript 客户端减半模块化 AWS SDK 的发布规模

您可以检查在 包装恐惧症上安装模块化包的成本。...我们还将类型作为分布在不同的文件夹中。 为了帮助客户,服务船提供了广泛的服务和运营文档。我们在 JSDoc 评论中添加此文档。在我们的 TSConfig 设置中,我们在每个分发中都发货了多余的注释。...当您在代码中的符号上悬停时,JSDoc 评论会出现。在下面的示例中,当在导入上盘旋时,您会看到 DynamoDB 的 JSDoc。 此 JSDoc 来自文件。...我们在推特上问了这样一个问题, 维护者是否将源代码以 npm 包中运送。以下是其中一个答复中的一段话:"航运源代码违背了模块定义的精神"。...我们也没有考虑使用高级或替代的汇编选项,如谷歌关闭编译器,巴贝尔或SWC。如果您有想法/建议或例子,他们如何可以帮助,请评论 GitHub 问题 aws/aws-sdk-js-v3/#2897.

2.4K20
  • 现代 JavaScript 库打包指南

    最后,这个指南不针对某一个特定的打包工具 —— 已经有许多指南来说明如何在配置特定的打包工具。相反我们聚焦于每个库和打包工具(或不用打包工具)都适用的事项。...输出多文件 通过保留文件结构更好地支持 treeshaking 如果你对你的库使用了打包工具或编译器,可以对其进行配置以保留源文件目录结构。...一种选择是继续在源代码中使用 JavaScript,然后通过 JSDoc 注释来支持类型。然后,你可以将 TypeScript 配置为仅从你的 JavaScript 源代码中构建类型文件。...这意味着你可以有两个不同的文件夹,都使用 .js 文件,但每个文件夹都有自己的 package.json 并设置为不同的 type 以获得基于 CommonJS 和 ESM 的文件夹。...设置给 CDN 使用的附加字段 支持 CDN,例如 unpkg 和 jsdelivr 为让你的库在 CDN 上“以默认的方式正常工作”,如 unpkg 和 jsdelivr,你可以设置它们的特定字段指向你的

    2.4K20

    不是Typescript用不起,而是JSDoc更有性价比?

    直到 2011 年,重构后的 JSDoc 3.0 已经可以运行在 Node.js 上 JSDoc 语法举例 定义对象类型: /** * @typedef {object} Rgb * @property...return a boolean */ return isType; } 至于动态引入 TS 定义也很简单,不管项目本身是否支持 TS,我们都可以放心大胆地先定义好类型定义的 .d.ts 文件,如:...,其割裂在前端项目中反映为一系列问题: API 数据接口的入参、响应类型模糊不清 表单项的很多默认值需要硬编码、多点维护 前后端对于同一概念的变量或动作命名各异 mock 需要手写,并常与最后实际数据结构不符...这种方式确保了不同语言之间数据结构的一致性,并提供了跨语言的数据序列化和反序列化能力 但是这无疑要求前后端团队同时改变其开发方式,如果不是从零起步的项目,推广起来还是有一点难度 因此,结合 JSDoc...理论上如果能基于 AST 等手段当然更好,但如本例中的 Java 似乎没有特别成熟的转换工具,java-parser 等库文档资料又过少。

    55710

    如何规范地发布一个现代化的 NPM 包?

    最后,这个指南不针对某一个特定的打包工具 —— 已经有许多指南来说明如何在配置特定的打包工具。相反我们聚焦于每个库和打包工具(或不用打包工具)都适用的事项。...输出多文件 通过保留文件结构更好地支持 treeshaking 如果你对你的库使用了打包工具或编译器,可以对其进行配置以保留源文件目录结构。...一种选择是继续在源代码中使用 JavaScript,然后通过 JSDoc 注释来支持类型。然后,你可以将 TypeScript 配置为仅从你的 JavaScript 源代码中构建类型文件。...这意味着你可以有两个不同的文件夹,都使用 .js 文件,但每个文件夹都有自己的 package.json 并设置为不同的 type 以获得基于 CommonJS 和 ESM 的文件夹。...设置给 CDN 使用的附加字段 支持 CDN,例如 unpkg 和 jsdelivr 为让你的库在 CDN 上“以默认的方式正常工作”,如 unpkg 和 jsdelivr,你可以设置它们的特定字段指向你的

    2.3K20

    手把手教你写 Roslyn 修改编译

    欢迎转载、使用、重新发布,但务必保留文章署名林德熙(包含链接:http://blog.csdn.net/lindexi_gd ),不得用于商业目的,基于本文修改后的作品务必以相同的许可发布。...Roslyn 如何基于 Microsoft.NET.Sdk 制作源代码包 本文告诉大家如何做源代码包,源代码包的意思是安装的包不是安装dll的方式,而是使用源代码的方式。...只需要在项目文件夹,或者磁盘的文件夹,如 E:\ 放下本文提供的 Directory.Build.props 文件,整个文件夹内的控制台项目就会输出 林德熙是逗比 想要知道是怎么做的,请看下面 Roslyn...Roslyn 通过 Nuget 引用源代码 在 VS 智能提示正常但是无法编译 本文告诉大家如果在 Nuget 引用源代码的方式引用源代码,在 VisualStudio 的智能提示和 Resharper...本文来告诉大家如何用 Roslyn 管理配置,在开一个新的项目的时候经常需要添加公司,版权等,但是这些信息不想每次都添加于是我就想用 Nuget 管理所有配置,安装一个 nuget 就自动配置 Roslyn 如何在

    2.1K20

    开源库架构实战——从0到1搭建属于你自己的开源库

    mt-events 的功能更倾向往前端事件绑定工具的趋势发展,因为我们集成了事件委托等,您可以像使用 JQuery 的 on 方法那样使用我们的 mt-events,更加便捷事件绑定和委托,让移动端事件如原生事件般友好...---- mt-events 初探 先看看 mt-events 这款工具库具有哪些特性: 普遍性:封装常用的移动端事件: 单击 双击 长按 滑动 拖拽 便捷性:在全局挂载工具函数,绑定事件如 $.on(...JSDoc 分析的源代码是我们书写的符合 Docblock 格式的代码注释,它会智能帮我们生成美观的 API 文档页面,我们要做的,只是简单的跑一句jsdoc命令就可以了。...这些都是JSDoc自动生成的): ? ​...mt-events从0到1 目录结构 mt-events ├── core # 源代码文件夹 │ ├── event.js # 自定义事件处理句柄生成器

    1.3K20

    大话 JavaScript(Speaking JavaScript):第二十六章到第三十章

    例如: 有多少空格(括号后,语句之间等) 缩进(例如,每级缩进多少空格) 如何在哪里编写var语句 第二条规则是,如果你加入一个现有项目,你应该严格遵循它的规则(即使你不同意它们)。...以下是一些指导方针: 更短并不总是更好 有时写更多意味着事情实际上更容易阅读。让我们考虑两个例子。首先,熟悉的事物更容易理解。这意味着使用熟悉的、稍微更冗长的结构可能更可取。...在类 C 语言(如 Java 和 JavaScript)中,有两种最常见的括号样式:Allman 样式和 1TBS。...ECMAScript 5 还允许你使用保留字(如new)作为属性键: > var obj = { new: 'abc' }; > obj.new 'abc' 有争议的规则 让我们看看一些我喜欢的、有点具有争议的惯例...Language Mechanisms for Debugging 译者:飞龙 协议:CC BY-NC-SA 4.0 以下三种语言结构有助于调试。

    16210

    现代 JavaScript 库打包指南

    最后,这个指南不针对某一个特定的打包工具 —— 已经有许多指南来说明如何在配置特定的打包工具。相反我们聚焦于每个库和打包工具(或不用打包工具)都适用的事项。...输出多文件 通过保留文件结构更好地支持 treeshaking 如果你对你的库使用了打包工具或编译器,可以对其进行配置以保留源文件目录结构。...一种选择是继续在源代码中使用 JavaScript,然后通过 JSDoc 注释来支持类型。然后,你可以将 TypeScript 配置为仅从你的 JavaScript 源代码中构建类型文件。...这意味着你可以有两个不同的文件夹,都使用 .js 文件,但每个文件夹都有自己的 package.json 并设置为不同的 type 以获得基于 CommonJS 和 ESM 的文件夹。...设置给 CDN 使用的附加字段 支持 CDN,例如 unpkg 和 jsdelivr 为让你的库在 CDN 上“以默认的方式正常工作”,如 unpkg 和 jsdelivr,你可以设置它们的特定字段指向你的

    89810

    入门干货之用DVG打造你的项目主页-Docfx、Vs、Github

    Docfx,类似JSDoc或Sphinx,可以从源代码中提取注释生成文档之外,而且还有语法支持你加入其他的文件链接到API添加额外的说明,DocFX会扫描你的源代码和附加的文件为你生成一个完整的HTML...0x02、吐槽 我觉得VS上的github插件巨难用,反正我用它上不来气儿。之前本人用惯了PC端,高端大气上档次,同时也保证了简洁清爽功能全。...5、你敲完了之后会有一个新的文件夹叫:“docfx_project”, 别害怕,把里面你的东西都剪切出来,放到外面(就是你clone出来的本地文件夹),然后删掉这个docfx_project文件夹。...此时你可以向Github上提交一次你的改动。 a、 b、 c、 d、 提交失败的话可能服务器版本中,某些文件比你新,那你就点蓝色的同步。没有就点推送推过去。...其他一些高级的编辑技巧,参见makedown,另外也可以参考我的另一个开源项目的文档,https://github.com/NMSLanX/Mellivora 注:Github库里的文件图片可能在你发布的项目主页上引用不到

    86060

    现代 JavaScript 库打包指南

    最后,这个指南不针对某一个特定的打包工具 —— 已经有许多指南来说明如何在配置特定的打包工具。相反我们聚焦于每个库和打包工具(或不用打包工具)都适用的事项。...输出多文件 通过保留文件结构更好地支持 treeshaking 如果你对你的库使用了打包工具或编译器,可以对其进行配置以保留源文件目录结构。...一种选择是继续在源代码中使用 JavaScript,然后通过 JSDoc 注释来支持类型。然后,你可以将 TypeScript 配置为仅从你的 JavaScript 源代码中构建类型文件。...这意味着你可以有两个不同的文件夹,都使用 .js 文件,但每个文件夹都有自己的 package.json 并设置为不同的 type 以获得基于 CommonJS 和 ESM 的文件夹。...设置给 CDN 使用的附加字段 支持 CDN,例如 unpkg 和 jsdelivr 为让你的库在 CDN 上“以默认的方式正常工作”,如 unpkg 和 jsdelivr,你可以设置它们的特定字段指向你的

    92730

    TypeScript 5发布,带来了哪些惊喜?一文告诉你

    TypeScript 5是微软开发的一种在JavaScript基础上添加类型语法的编程语言,它可以帮助开发者在编译时检查代码中的错误,并提供更好的编辑器支持。...为了解决这些问题,TypeScript 5提供了一个新选项 –moduleResolution bundler ,它可以让TypeScript按照打包工具(如webpack、rollup等)的方式来解析模块...,并且保留原始导入语句不做转换。...字段指定多个其他配置文件; 所有枚举都是联合枚举:使得枚举类型更加灵活和安全; –verbatimModuleSyntax :支持 export type * 的语法; @satisfies 支持 JSDoc...:允许使用 @satisfies 标签来指定类实现了某个接口或抽象类; @overload 支持 JSDoc:允许使用 @overload 标签来定义函数重载; 在 –build 下传递生成相关选项:允许在使用

    55730

    WPF 如何知道当前有多少个 DispatcherTimer 在运行

    本文来告诉大家如何在 WPF 中调试当前主线程有多少个 DispatcherTimer 在运行 在 WPF 中,如果有 DispatcherTimer 定时器在执行,将会影响到主线程的执行,将会让主线程诡异忙碌...可以在此方法上添加断点,如下图 进入 VisualStudio 的监视界面,输入 System.Windows.Threading.Dispatcher.CurrentDispatcher....原因是 System.Windows.Threading.DispatcherTimer 定义在 WindowsBase 程序集 接下来在断点窗口里面,点击新建函数断点 输入调试的函数,进行断点,如断点放在...,先创建一个空文件夹,接着使用命令行 cd 命令进入此空文件夹,在命令行里面输入以下代码,即可获取到本文的代码 git init git remote add origin https://gitee.com...欢迎转载、使用、重新发布,但务必保留文章署名林德熙(包含链接: https://blog.lindexi.com ),不得用于商业目的,基于本文修改后的作品务必以相同的许可发布。

    1K30

    鸿蒙开发 ArkTS 工程目录结构详解

    json5 是 JSON 的超集,允许更多的灵活配置,如注释和尾逗号。2. entry 目录entry 目录是开发的核心部分,包含了应用模块的源代码、资源、配置以及构建任务。...它的结构决定了应用的模块化和可扩展性。src:存放应用的源代码,主要是 ArkTS 的代码部分,分为以下几个子目录:ets:存放 ArkTS 源码,包括应用的入口、扩展能力以及页面定义。...HAP 包的配置信息,描述了应用如何在目标设备上运行,以及不同设备之间的适配。应用/服务的全局配置信息。...其他编译参数,如文件输出路径、模块版本等。hvigorfile.ts:该文件是模块级的构建任务脚本,用于定义模块的编译任务,例如如何处理源代码、如何构建应用包等。...三、总结了解鸿蒙 ArkTS 工程的目录结构是开发鸿蒙应用的重要基础。各个目录和文件分别承担不同的职责,从源代码、资源文件到编译配置和第三方依赖,都是构建高效、可维护应用的关键部分。

    18500

    你会了吗 HarmonyOS Next 项目级别的注释规范

    HarmonyOS Next 项目级别的注释规范 程序员箴言 我最讨厌世界上的两种人: 第一种是不写注释的人 第二种是让我写注释的人 前言 随着HarmonyOS NEXT的发展加快,不少的公司已经陆续加大了资源来开发软件项目...目前主流的IDE都会支持 jsDoc 或者 TypeDoc。 我们按照规定的格式编写代码注释,便能获得以下好处: 当我们想要调用 全局函数 px2vp时,提示工具会很清晰的给我展现出相关的使用说明。...在你引入代码提示的时候,也可以直观的观察这里来判断它是什么类型 常见代码提示修饰符 如图,如果我们想要实现上图右侧的一些语法提示功能,那么就需要自己编写合适的代码提示修饰符了 通过编写一个类来演示,首先我们提供以下基本结构...如 遵循 上述jsDoc的一些规范 DevEco Studio 快速生成说明文档 DevEco Studio NEXT Beta1(5.0.3.814) 当前支持对工程或目录下.ets/.ts/.js/...若选择对工程/目录整体导出ArkTSDoc文档,生成后的ArkTSDoc文档目录和原目录结构一致。

    5600

    python面试题--1

    Python程序直接从源代码运行。它将程序员编写的源代码转换为中间语言,再次转换为必须执行的机器语言。 5)如何在Python中内存管理? Python内存由Python私有堆空间管理。...比如说按创建日期排序的所有用户名,如["Seth", "Ema", "Eli"]。 元组表示的是结构。可以用来存储不同数据类型的元素。...Python程序的文件夹是一个模块包。包可以包含模块或子文件夹。 26)提到Python中局部变量和全局变量的规则是什么? 局部变量:如果在函数体内的任何位置为变量赋值,则假定它是本地的。...28)解释如何在Unix上创建Python脚本? 要在Unix上使Python脚本可执行,您需要做两件事, 脚本文件的模式必须是可执行的 第一行必须以#开头(#!...Flask脚本工作的常用方法是: 应用程序的导入路径 或者是Python文件的路径 39)解释如何在Flask中访问会话? 会话基本上允许您记住从一个请求到另一个请求的信息。

    6010

    使用GitLabCI实现monorepos项目CICD

    如何在这样的项目中组织源代码?一种解决方案是monorepo,即项目中所有源代码在同一个存储库中管理。还有一种是每个微服务分别创建一个存储库管理。...所有源代码都在一个monorepo中进行管理。...基本上,GitLab CI / CD管道包括几个阶段如build,test和deploy。该管道配置有一个名为.gitlab-ci.yaml的文件,该文件存储在我们存储库的根目录中。...为了确保仅在更改服务源代码后才执行该服务的作业,我们可以将only/changes子句与文件夹路径的正则表达式结合使用。...所需的命令和脚本在很大程度上取决于我们项目的测试基础结构,但基本上,我们调用的脚本与在本地开发环境中使用的脚本相同。使用GitLab CI / CD也可以进行更复杂的测试,例如集成或端到端测试。

    9.5K30
    领券