摘要：简介是众多开源项目中的一个，它是使用编写的文档生成器。系统环境变量，对所有用户起作用。使用可通过配置，也可通过直接在命令行写参数来使用。配置进入项目目录，配置文件，类似以下的写法运行命令，即可在文件夹下找到自动生成的文档。
简介
jsduck是senchalabs众多开源项目中的一个，它是使用ruby编写的 javascript API文档生成器。不像JSDoc一样，不按照符合JSDoc的注释语法来进行注释的话，可能生成的文档一个字也没有，学习曲线较陡。jsduck适合以OOP方式构造代码（如Ext JS是结构化的）的js文件，不适合以功能性风格构建代码（如jQuery）的js文件。
安装 下载安装包项目地址：https://github.com/senchalabs...
windows下安装的话，可在这个地址下载.exe可执行文件，将下载后的文件更名为jsduck.exe，放到一个目录下面。
windows下需要配置环境变量。环境变量分为系统环境变量和用户环境变量两种。系统环境变量，对所有用户起作用。而用户环境变量只对当前用户起作用。 我们可配置在用户环境变量的path中，也可配置在系统环境变量的path中。
点击计算机，右键选择属性——》高级-》环境变量，在Path中进行设置。
配置完成，进入dos命令，运行jsduck --help，能出来信息，则表示配置成功。
使用可通过配置jsduck.json，也可通过直接在命令行写参数来使用。
配置jsduck.json进入项目目录，配置jsduck.json文件，类似以下的写法
运行jsduck命令，即可在dist文件夹下找到自动生成的api文档。
文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。
转载请注明本文地址：https://www.ucloud.cn/yun/91899.html
摘要：语法父类名表示当前类继承于哪个类的标签。成员标签成员标签作用于类中的配置属性函数事件。表明可被子类继承，和一起使用。示例获取圆的面积圆的半径面积值作用于函数，表明函数的标签。作用于函数，表明构造函数参数的标签，用法同。 字数：3692字 阅读时间：15分钟 前言 首先，咱们有一个前提，JSDuck对我们而言只是一个便于API查看的文档化工具。因此，只要它能够满足我们文...
摘要：我们在对现在较主流的五个文档工具分别作了调研和尝试，得到结论如下工具优点缺点提供了完整的模板开发事件触发等接口，使用非常灵活。至此，的环境部署已经全部完成了。 字数：981 阅读时间：5分钟 选型依据 在经历了数个上线的项目之后，笔者所在的团队已经沉淀了一个相对稳定版本的前端框架。因此，我们需要出具一套框架API文档，以便公司其他成员的使用和框架的后期维护。我们在对...
摘要：本文比较了种较为主流的注释文档生成工具。应该说是非常适合开源项目多个作者共同维护的一个文档工具。最后我选择了作为文档生成的工具。为了支持多种语言，它仅对注释块内部的内容进行解析。 最近随着写Node以及独立的CommonJS模块越来越多，我发现有一份好的文档不仅可以帮助自己在应用这些接口的时候不至于迷糊，而且对于共同开发的情况下，能够省去大量团队的交流和Debug的时间。 本文比较了...
摘要：融合思路解决这个问题，有两种思路。给我们带来了以下新成员模块服务指令筛选器和控制器。与其他类是通过类的名称区分的，名称统一以结尾。这种处理方式是一种折中方案，如果想要更加规范优雅的话，建议使用自定义标签来解决。 字数：1568 阅读时间：10分钟 前言 前面，我们以一个实战案例来详细说明了如何在实际开发中使用JSDuck工具。但是，并不是所有的时候，代码的封装方式都受我们控制的。...
阅读 3773·2021-11-24 09:38
阅读 1057·2021-10-19 11:42
阅读 1690·2021-10-14 09:42
阅读 2058·2019-08-30 15:44
阅读 438·2019-08-30 14:04
阅读 2789·2019-08-30 13:13
阅读 1781·2019-08-30 12:51
阅读 814·2019-08-30 11:22
