Javascript API文档生成工具YUIDoc的安装

        YUIDoc是基于Nodejs的可以将文档中的注释生成API文档的工具。它可以时时预览你写入的内容,支持自定义文档模版,生成的文档清晰易用,并且不局限于你所使用的语言,只要你的代码中按照YUIDoc规范的格式来写注释就可以生成想要的API文档,因此在各团队协作中用来作为统一的文档工具再合适不过了。

       在windows下的安装:


       1.YUIDoc 是一个基于 Node.js 的应用程序,因此先要下载安装Nodejs


       2.修改系统变量Path 路径:添加 Nodejs安装目录

     


        添加系统变量 NODE_PATH添加 Nodejs安装目录中node_modules的路径


     

  

       3.安装完后在cmd命令行输入:node -v    若出现Nodejs版本,则安装成功

       

        4.命令行运行如下命令安装YUIDoc :npm -g install yuidocjs

        运行命令后,会看到一堆GET请求,之后YUIDoc就自动下载安装到Nodejs模块目录下并且将它加入系统的环境变量里,这样你

    就可以在任意文件夹下使用YUIDoc命令了。

      5.使用YUIDoc:

     你可以在现有或者新建的项目的js里加入YUIDoc语法格式的注释(YUIDoc语法参考),然后运行cmd,切换到项目目录下运行以

下命令,API文档就可以生成了。

     在js文件夹中执行:

   yuidoc .   执行后若无错误提示,在js文件夹内就会发现多了一个'out'文件夹,生成的API文档就在里面了。

    



  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

txp1993

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值