JSDoc那些事

几天工作上需要文档化一些Javascript东西，所以在找一些JS文档化工具，以下分析几种工具。

1.JSDoc-toolkit

一开始还想用这个工具，但后来在解析生成文档时候，出现了很严重的错误，还存在其他问题。

问题1：闭包存在时候，解析出错(很严重) ，导致几乎就不能用来做JS文档化。

问题2：在Javascript部分，注释怎么写都不对，感觉这个工具使用起来很困难

问题3：如果是静态函数或prototype设置函数，就会出问题，warning错误，然后生成的文档很怪异

之所以会出现上面种种问题，关键点就是解析时需源代码，这问题太严重了。

也是解析出错这个原因，导致最后不得不舍弃这个工具。

建议：JavaDoc可以用，感觉这种工具更多是给Java用的

2.JSDoc

很类似JSDoc-toolkit ，注释方式几乎一样，没什么差别，同样解析需源代码（又不得不舍弃）。

PS:因为不同的人写js的方式千奇百怪，不能强制js的写法，最好是只需要规范注释写法，文档生成工具从注释获取信息来生成文档。

3.YUIDoc

只解析YUIdoc的注释块，不解析源代码(令人振奋的消息，可以支持多种语言,产生错误 的可能将大大减小)，只需要安装nodejs，在命令行安装YUIDoc就可用了，使用起来也非常简单。但是，这个工具还是基于面向对象语言来做文档化的，所以在给JS使用时，还是有些怪异，不过这些问题是可以忍受的。

总之，一个好的文档化工具，最好是有两钟模板，一个给函数式语言使用，一种给面向对象语言使用，两者杂糅起来挺不好的。另外最好是简单易用，特别不要出现解析出错，一出现解析出错，相信再好用再华丽也没有人用。