YUI Doc JavaScript API文档生成工具开源项目

我要开发同款
匿名用户2009年10月16日
89阅读

技术信息

开源地址
https://github.com/sphinx-doc/sphinx/
授权协议
BSD

作品详情

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

功能介绍

YUIDoc 是一个基于 Node.js 的应用程序,用来根据 JavaScript 的注释中生成 API 文档,类似 JavaDoc,这也是当前 YUI 用来生成文档的工具。 生成的文档效果:...

示例图片

声明:本文仅代表作者观点,不代表本站立场。如果侵犯到您的合法权益,请联系我们删除侵权资源!如果遇到资源链接失效,请您通过评论或工单的方式通知管理员。未经允许,不得转载,本站所有资源文章禁止商业使用运营!
下载安装【程序员客栈】APP
实时对接需求、及时收发消息、丰富的开放项目需求、随时随地查看项目状态

评论