YUI DocJavaScript API文档生成工具
YUIDoc 是一个基于 Node.js 的应用程序,用来根据 JavaScript 的注释中生成 API 文档,类似 JavaDoc,这也是当前 YUI 用来生成文档的工具。
生成的文档效果:
示例语法:
/**
* My method description.  Like other pieces of your comment blocks, 
* this can span multiple lines.
*
* @method methodName
* @param {String} foo Argument 1
* @param {Object} config A config object
* @param {String} config.name The name on the config object
* @param {Function} config.callback A callback function on the config object
* @param {Boolean} [extra=false] Do extra, optional work
* @return {Boolean} Returns true on success
*/ 
YUIDoc 提供:
- 即时预览
 - 流行的标注
 - 支持多种语言
 
其他特性:
- 注释支持 Markdown 语法
 - Support for many more tags out of the box
 - Logic separated to allow for easy extensibility
 - Better theming support
 - Server mode for development time previews
 - External data mixing
 - Easy cross platform installation
 - Cross-linking inside and out of current project
 - JSON based configuration
 
评论
