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文档就在里面了。