不管你是做前端还是做后台，你终会发现，不管你的代码自说明再怎么好，但你和别的同事共同开发或者重复应用或者经过一段时间之后自己去维护代码的时候，你都会发现同事或者自己都会产生很多疑问，或是不清楚已有哪些接口或是忘记具体的方法等等，就不得不费功夫去询问，去打开源文件来查找，此时如果有相应的文档供查询，那么就可以节省很多成本。文档化工具有很多，我只为文档化Javascript，这里选用的是YUI Doc。

YUI Doc是由注解驱动(comment-driven)的系统，通过解析代码中描述结构的注解来生成文档。由于它纯粹的依赖于注解，所以并不像一些模拟系统一样需要有惯用语和代码模式。YUI Doc基于Python而且依赖三个类库和一个工具，所以像我这种没接触过的喜欢双击一下就完事的人来说，觉得挺费劲的，研究了Windows 7(64bit)下YUI Doc的安装（具体安装方法在YUI Doc的压缩包中有描述）：

1.安装Python

建议安装2.7版本，后面用到的easy_install目前只支持到这个版本，其他我还没试过，待验证，安装完之后在环境变量Path中添加安装目录，如C:Python27。

2.安装Setup Tools

安装程序无法识别出我的Python，最后用了个py安装程序，在装好Python后直接双击就好了，将会在Python的安装目录下生成一个Script文件夹，在将这个文件夹的路径添加到环境变量Path中，到此我们就可以用easy_install去安装依赖库了，跟Linux下差不多。

3.安装依赖库

easy_install pygments
easy_install Cheetah
easy_install simplejson

4.配置YUI Doc
拷贝yuidocbinexample.bat文件改名(如demo.bat)并打开，改名可以配置多个文件执行不同的任务。

REM The location of your yuidoc install
SET yuidoc_home="c:homewwwyuidocyuidoc"
REM YUI Doc所在路径

REM The location of the files to parse.  Parses subdirectories, but will fail if
REM there are duplicate file names in these directories.  You can specify multiple
REM source trees:
REM      SET parser_in="c:homewwwyahoo.devsrcjs c:homewwwEvent.devsrc"
SET parser_in="c:homewwwyahoo.devsrcjs"
REM 源码路径

REM The location to output the parser data.  This output is a file containing a
REM json string, and copies of the parsed files.
SET parser_out="c:homewwwdocsparser"
REM 解析的js文件

REM The directory to put the html file outputted by the generator
SET generator_out="c:homewwwdocsgenerator"
REM 生成的API文档

保存demo.bat，双击运行即可。

附 Stephen Woods — Creating Beautiful Documentation with YUI Doc的视频及PPT：