JSDoc3、Doxx，YUIDoc简单介绍和对比

这几天需要对开发的js文件生成doc，简单了解了一下，直接选用了JSDoc3，但JSDoc3默认生成的doc比较难看。于是就再看看其它的生成软件。

看了一篇写的不错的文章，对JSDoc、Doxx、YUIDoc、Docoo做了对比，地址：http://blog.fusioncharts.com/2013/12/jsdoc-vs-yuidoc-vs-doxx-vs-docco-choosing-a-javascript-documentation-generator/，有兴趣的可以看一下。

看了文章中的几个效果图，大家可以自己去看看。我看完之后，觉得Doxx和YUIDoc比较好看，所以也想试试。

1、JSDoc

这个在《JSDoc3的简单使用》中介绍了，这里不写了。贴个默认效果图。

 

2、Doxx

开源地址：https://github.com/FGRibreau/doxx

1.Doxx需要NodeJS支持，首先下载安装NodeJS，地址：http://www.nodejs.org/

2.安装Doxx，随便开个dos窗口，执行：

npm install doxx -g

这样Doxx就安装好了。

执行命令：

doxx -h

可以看到doxx命令行的参数说明。

比如我的js文件放在D:\myjs目录中，要生成的doc目录为D:\doxx_doc，则执行如下命令：

doxx -s d:\myjs -T d:\doxx_doc

执行完毕后，我们会看到D盘下自动生成doxx_doc目录，点击其中的index.html可以就可以看到生成的jsdoc了。贴个效果图：

效果挺好看的，但仔细看看，发现效果并不是很好，左侧导航把方法，参数，属性全列出来了，内容区也是有些混乱。

3、YUIDoc

开源地址：https://github.com/yui/yuidoc

1.Doxx需要NodeJS支持，首先下载安装NodeJS，地址：http://www.nodejs.org/

2.安装YUIDoc，开dos窗口执行如下命令：

npm -g i yuidocjs

安装好之后，执行dos命令：

yuidoc -h

可以查看YUIDoc命令行下的相关参数说明。

比如我的js文件放在D:\myjs目录中，要生成的doc目录为D:\yuidoc_doc，则执行如下命令：

yuidoc -o d:\yuidoc_doc d:\myjs

执行完毕后，在D盘下自动生成yuidoc_doc目录，点击其中index.html就可以看到生成的jsdoc了。贴效果图：

看起来，效果也不错。但在我这里用的时候，在生成的过程中出现大量警告，导致左侧导航中的挺多类的帮助并没有生成。但我的类中js注释都是满足JSDoc要求的。

 

以上，只是简单介绍一下和效果图对比，希望不要对大家有误导，也可能是我不熟悉或者代码有什么问题导致效果不是那么完美。

受文章《JSDoc vs YUIDoc vs Doxx vs Docco – Choosing a JavaScript documentation generator》的影响，和我自己的比较，我决定继续使用JSDoc。但要加上Docstrap的配合。这个下一篇再讲。