YUIdoc工具介绍 ? (yuidoc后面是1个空格1个点号) YUIdoc就会在当前目录新建一个out文件夹,并将文档输出为本地静态网站,完成后只需要打开out目录中的index.html就可以本地查看API离线文档了,下图即是 YUIdoc默认样式生成的离线文档: ? YUIdoc工具介绍 官方仓库:https://github.com/yui/yuidoc YUIdoc是一个基于模板引擎Handlebars.js 的自动化文档工具,可以将javascript中 jsdoc风格通常都会有IDE插件直接生成(vscode和sublime里肯定是有的,因为我自己天天用),最常见的是函数声明注释,YUIdoc中可以识别的所有语法可以查看官方提供的【YUIdoc支持的注释语法
复制其bin目录下的example.bat文件,重命名为test.bat,然后用记事本或其他编辑器打开并配置它: SET yuidoc_home="D:\yui\yuidoc" REM YUI 支持中文注释的解决方案 下载最新版本YUI Doc,解决方案在yuidoc-27中验证通过 把所有.js文件都转成不带BOM的UTF-8编码 修改文件/bin/yuidoc_highlight.py
编写API文档 手写文档一定会让你觉得痛苦,ok,在JavaScript领域,可以使用JSDoc Toolkit或者YUIDoc来自动生成文档。当然,你要按照一定的格式。 return output; } YUIDoc范例 这个东西就不写具体的示例了,仅作了解即可,网上可以找到很多例子。 要注意的是,YUIDoc系统是一个和语言无关的系统,它仅仅解析注释的部分,而不解析JavaScript代码。缺点是不得不在注释中声明属性名、参数名和方法名。
jqueryui.com/demos/ jQuery中文文档(非官方):http://www.css88.com/jqapi/ YUI 2库文档(英):http://developer.yahoo.com/yui/yuidoc
YUI3的几点说明 YUI3是一个重量级的前端框架库,它提供了单元测试(YUITest),生成文档(YUIDoc),自动化编译(YUI Build)等工具,在代码组织方面有统一的微件(widget)
2.YUIDoc和JSDoc可以将所有的注释转换为HTML。 3.Docco/Rocco,从代码中解析出Markdown风格的注释。
return output; }; YUIDoc范例 http://www.jspatterns.com/book/2/ /** * 我的JavaScript应用程序 * * @module myapp
同时 YUI也有着丰富的产品线,拥有测试框架 YUITest、文档生成框架 YUIDoc、自动构建框架 YUI Build,满足项目开发各方面的需求。随着Yahoo!
同时 YUI也有着丰富的产品线,拥有测试框架 YUITest、文档生成框架 YUIDoc、自动构建框架 YUI Build,满足项目开发各方面的需求。随着Yahoo!
YUIDoc是一个Node.js应用程序,它使用类似于Javadoc和Doxygen等工具的语法,从源代码中的注释生成API文档。 coddoc是一个jsdoc解析库。
YUIDoc是一个Node.js应用程序,它使用类似于Javadoc和Doxygen等工具的语法,从源代码中的注释生成API文档。 coddoc是一个jsdoc解析库。