如何查看jsplumb.js的API文档(YUIdoc的基本使用)

如何查看jsplumb.js的API文档(YUIdoc的基本使用)

示例代码托管在:http://www.github.com/dashnowords/blogs文章来源地址https://www.yii666.com/article/754357.html网址:yii666.com<

博客园地址:《大史住在大前端》原创博文目录

华为云社区地址:【你要的前端打怪升级指南】

目录
  • 一.问题描述
  • 二. 处理方法
  • 三. YUIdoc工具介绍

一.问题描述

最近向一些同事推荐了网页中实现流程图绘制的工具库jsplumb.js,Community版本是开源的,在github的官方仓库的Wiki中能够找到社区版的官方指南,非常非常详细。但是在后来很多人反馈说找不到API文档,github官方仓库中的API文档链接失效了,jsplumb.js官网也找不到。

二. 处理方法

其实API文档就放在官方代码仓中,只是需要一些小小的加工,具体步骤如下:文章地址https://www.yii666.com/article/754357.html网址:yii666.com文章来源地址:https://www.yii666.com/article/754357.html

1.先从官方代码仓https://github.com/jsplumb/jsplumb 将master分支的工程拉取到本地

2.使用npm install yuidocjs -gyarn global add yuidocjs全局安装文档工具YUIdoc

3.进入刚才下载的工程目录中的/doc/api文件夹

4.打开cmd小黑窗,输入yuidoc .(yuidoc后面是1个空格1个点号)

YUIdoc就会在当前目录新建一个out文件夹,并将文档输出为本地静态网站,完成后只需要打开out目录中的index.html就可以本地查看API离线文档了,下图即是YUIdoc默认样式生成的离线文档:

如何查看jsplumb.js的API文档(YUIdoc的基本使用)

怎么样,这个技能你Get到了吗?

三. YUIdoc工具介绍

官方仓库:https://github.com/yui/yuidoc

YUIdoc是一个基于模板引擎Handlebars.js自动化文档工具,可以将javascriptjsdoc风格的注释语句转换成静态网站式的离线文档,所以你可以通过定制模板来为最终生成的文档增加不同的主题样式。jsdoc风格通常都会有IDE插件直接生成(vscodesublime里肯定是有的,因为我自己天天用),最常见的是函数声明注释,YUIdoc中可以识别的所有语法可以查看官方提供的【YUIdoc支持的注释语法】:

//jsdoc风格的注释

/**
* My method description. Like other pieces of your comment blocks,
* this can span multiple lines.
*
* @method methodName
* @param {String} foo Argument 1
* @param {Object} config A config object
* @param {String} config.name The name on the config object
* @param {Function} config.callback A callback function on the config object
* @param {Boolean} [extra=false] Do extra, optional work
* @return {Boolean} Returns true on success
*/

你可以通过-e参数来指定注释文件的格式,例如你的工程是基于Typescript开发的,就可以使用yuidoc . -e .ts将项目中的*.d.ts声明文件转换成离线文档,以便团队内部查阅。如果你开发的是一个工具库,需要生成完备的API文档,为了不影响源码阅读和开发,可以像jsplumb.js那样将注释语句单独写在一个文件中,因为是一个自动化工具,也没什么太多可讲的,有需要的朋友直接浏览一下官网就可以很容易地使用了。

版权声明:本文内容来源于网络,版权归原作者所有,此博客不拥有其著作权,亦不承担相应法律责任。文本页已经标记具体来源原文地址,请点击原文查看来源网址,站内文章以及资源内容站长不承诺其正确性,如侵犯了您的权益,请联系站长如有侵权请联系站长,将立刻删除

如何查看jsplumb.js的API文档(YUIdoc的基本使用)-相关文章

  1. Ext JS 6学习文档-第7章-图表

  2. Ext JS 6学习文档-第6章-高级组件

  3. float的元素脱离文档流,但不完全脱离,只是提升了半层;

  4. Jquery 文档的各种高度和宽度

  5. Sencha Cmd 6 和 Ext JS 6 指南文档(部分官方文档中文翻译)

  6. Effective Java 第三版——56. 为所有已公开的API元素编写文档注释

  7. 如何查看jsplumb.js的API文档(YUIdoc的基本使用)

  8. HTML元素脱离文档流的三种方法

    一、什么是文档流?将窗体自上而下分成一行一行,并在每行中按从左至右依次排放元素,称为文档流,也称为普通流。这个应该不难理解,HTML中全部元素都是盒模型,盒模型占用一定的空间,依次排放在HTML中,形成了文档流。二、什么是脱离文档流?元素脱离文档流之后,

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

微信图片_20190322181744_03.jpg

微信扫一扫打赏

请作者喝杯咖啡吧~

支付宝扫一扫领取红包,优惠每天领

二维码1

zhifubaohongbao.png

二维码2

zhifubaohongbao2.png