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
*/
其他特性:
YUI Team实践出了一个高效易协作的前端代码开发流程:代码首先由Ant来组织管理和版本化、接着由JsLint来验证,然后由YUI Doc文档化、最后由YUI Compressor进行压缩发布。上个月初,YUI Team公布了这个新的JavaScript API文档生成工具YUI Doc,它本来专门为YUI提供API级别的文档的,现在它开源为人民服务了。 YUI Doc和JavaDoc、JSDo
由于我们在项目工作中计划要试用YUI Doc,但不知如何入手,遂上Google搜索,找到的基本都是《如何开始使用YUI Doc工具?》一文。根据此文入手,发现其中已经部分不适用,因此我根据我的环境的实际情况和结合官方的YUI Doc文档,修正了部分内容并记录下来。以下开始还是引用原文,并以红色文字作为注解或修正: YUI Team实践出了一个高效易协作的前端代码开发流程:代码首先由
http://dancewithnet.com/2008/12/30/why-start-yui-doc/ 转载于:https://www.cnblogs.com/kaima/articles/1522449.html
最近在用YUI3.5制作一个报表网站,遇到个问题,需要打印报表,但是YUI下我是通过model化panel来显示报表内容的,一打印就把整个网页打出来,结果是背景完全是乱的,样式也不正常 YUI3的panel也是通过div实现的,于是想是否能通过只打印div内容方式实现 在网上搜索了下,打印div本身还是比较容易的,代码是这样的: <script language="javascript"> fun
最近在网上看到一个不错ajax的开发组件,支持GIRD 的实时处理 过段时间研究一下 源代码下载http://www.yui-ext.com/deploy/ 新启动的域名 http://www.extjs.com/ FAQ:http://yui-ext.com/manual/faq DOC:http://www.yui-ext.com/deploy/yui-ext/docs/ DEMO:http:
YUI是一个免费的,开源的Javascript和CSS库,用于构建丰富的交互式web应用程序。 YUI为我们提供了一个强大的JS框架的同时还提供了几个CSS的框架,分别是Reset、Base、Font以及Grid。通过在页面中引用这几个CSS,可以让我们的前端开发工作事半功倍,达到快速将美工图转化为实际产品、并且能够保证在绝大多数浏览器上的正常表现。 接下来我们来了解一下YUI的这几个CSS 1、
也许有些人不喜欢用YUI的CSS,但是我觉得这个对我来说,简直是太方便了,特别是如果你赞同Yahoo的栅格理论的话,YUI Css几乎可以用在你所有的项目上。但是也有缺陷,YUI预设的Template中只为我们提供了六种预设的模板,并没有像整个页面那样提供一个可以自定义的标签,那么当我们的需求需要实现不同的宽度的时候,就只有自定义了,我的目标是实现一个符合yui-t规则的自定义样式。 在进行之前,
本章内容简介: 建立跨浏览器一致性 控制字体 利用网格构建布局 15.1 建立跨浏览器一致性 每种浏览器制造商都构建了自己的布局算法,虽然这些算法非常接近,但并不完全相同。因此,在不同的浏览器上,页面中对象之间的距离甚至字体间距调整都可能稍有不同。实际上,对于浏览器目前的状态,不可能在不同的浏览器上实现完全相同的呈现效果。 YUI 的 CSS 文件试图尽可能地统一呈现引擎, 首先就是使用 rese
YUI的Node功能为获取、创建、操作DOM节点提供很易懂的方式。每个Node实例代表一个DOM节点,每个NodeList代表一系列DOM节点。我们可以管理Node的className(myNode.addClass(‘foo’)) 和样式(myNode.setStyle(‘opacity’, 0.5))、可以创建DOM元素(Y.Node.create(‘foo’))等。 引入YUI种子文件和配置
yui-base里面在定义了YUI构造器之后,构造器里面有一些实例方法,我们知道肯定是定义在了YUI的构造器原型上面的。 这里先解析_init方法,Y实例的一个初始化方法 _init: function() { var filter, Y = this,//Y已经是一个YUI的实例,this就是这个YUI实例, G_ENV = YUI.
本文向大家介绍Python文档生成工具pydoc使用介绍,包括了Python文档生成工具pydoc使用介绍的使用技巧和注意事项,需要的朋友参考一下 在Python中有很多很好的工具来生成字符串文档(docstring),比如说: epydoc、doxygen、sphinx,但始终觉得pydoc还是不错的工具,用法非常简单,功能也算不错,本文主要介绍pydoc. pydoc是Python自带的模块,
https://github.com/estan/protoc-gen-doc 这是一个Google Protocol Buffers编译器(protoc)的文档生成插件。这个插件可以从.proto文件中的注释内容生成HTML, DocBook 或者 Markdown 文档。 安装 参考 protoc-gen-doc Installation章节的信息。 linux安装 对于ubuntu系统,参考
easyopen提供一个简单的api文档查看页面,类似于swagger,基于注解功能来生成文档页面。生成的文档页面可以查看参数、结果说明,也可以进行模拟请求。对于前后端分离的项目来说会很有帮助。文档界面如下图所示: 左边的树形菜单对应文档名称,点击树可前往查看对应的接口说明。点击请求按钮可以发起请求进行测试。可修改业务参数中的值进行测试。 下面来讲解文档注解的使用方法。 文档页面默认是关闭的,需要
CabalPHP 支持接口文档自动生成。 编写好相关配置和文档注释后浏览器访问 http://127.0.0.1:9501/__docs 即可查看相关文档,注意检查自己的监听端口和IP。 点击这里访问示例文档 接口文档地址只能在debug环境(cabal.debug配置为true)下访问。 配置 文档相关配置在 conf/cabal.php // ... 'document' =
支持在项目中使用 Swagger 注解语法,运行命令,生成 Swagger 文件。 Swagger 是最流行的 API 开发工具,它遵循 OpenAPI Specification(OpenAPI 规范,也简称 OAS)。 Swagger 可以贯穿于整个 API 生态,如 API 的设计、编写 API 文档、测试和部署。 Swagger 是一种通用的,和编程语言无关的 API 描述规范。 imi-
Django的admindocs应用从模型、视图、模板标签以及模板过滤器中,为任何INSTALLED_APPS中的应用获取文档。并且让文档可以在Django admin中使用。 在某种程度上,你可以使用admindocs来快为你自己的代码生成文档。这个应用的功能十分有限,然而它主要用于文档模板、模板标签和过滤器。例如,需要参数的模型方法在文档中会有意地忽略,因为它们不能从模板中调用。这个应用仍旧有
原有插件生成的 HTML 文件内容和格式并不理想,考虑自行调整。 因此 fork 了原有仓库,准备动手修改。 这样就有必要能自己从c的源代码开始编译打包。 参考原有的插件打包说明: https://github.com/skyao/protoc-gen-doc/blob/master/BUILDING.md 准备工作 按照要求,需要准备两个东西: Protocol Buffers library
安装 protoc-gen-doc 简单遵循安装要求即可: https://github.com/estan/protoc-gen-doc 安装完成之后的protoc是2.5.0版本,无法处理proto3的文件。因此我们需要升级替换protoc为v3.0.0版本。 升级protoc 使用预编译版本 下载 请先在 protobuf 的 发布页面 中找到对应版本的 download ,然后下载对应版本