YUIDoc是一个基于Node.js的应用程序,用来根据JavaScript的注释中生成API文档,类似JavaDoc,这也是当前YUI用来生成文档的工具。
生成的文档效果:
示例语法:
/***Mymethoddescriptio.Likeotherpiecesofyourcommetblocks,*thiscaspamultiplelies.**@methodmethodName*@param{Strig}fooArgumet1*@param{Object}cofigAcofigobject*@param{Strig}cofig.ameTheameothecofigobject*@param{Fuctio}cofig.callbackAcallbackfuctioothecofigobject*@param{Boolea}[extra=false]Doextra,optioalwork*@retur{Boolea}Returstrueosuccess*/YUIDoc提供:即时预览流行的标注支持多种语言其他特性:
注释支持Markdow语法SupportformaymoretagsoutoftheboxLogicseparatedtoallowforeasyextesibilityBetterthemigsupportServermodefordevelopmettimepreviewsExteraldatamixigEasycrossplatformistallatioCross-likigisideadoutofcurretprojectJSONbasedcofiguratio










评论