YUIDoc是一个基于Node.js的应用程序，用来根据JavaScript的注释中生成API文档，类似JavaDoc，这也是当前YUI用来生成文档的工具。
生成的文档效果：
示例语法：
/***Mymethoddescription.Likeotherpiecesofyourcommentblocks,*thiscanspanmultiplelines.**@methodmethodName*@param{String}fooArgument1*@param{Object}configAconfigobject*@param{String}config.nameThenameontheconfigobject*@param{Function}config.callbackAcallbackfunctionontheconfigobject*@param{Boolean}[extra=false]Doextra,optionalwork*@return{Boolean}Returnstrueonsuccess*/YUIDoc提供:即时预览流行的标注支持多种语言其他特性：
注释支持Markdown语法SupportformanymoretagsoutoftheboxLogicseparatedtoallowforeasyextensibilityBetterthemingsupportServermodefordevelopmenttimepreviewsExternaldatamixingEasycrossplatforminstallationCross-linkinginsideandoutofcurrentprojectJSONbasedconfiguration
评论