YUIDoc是在构建时使用的Node.js应用程序,用于生成JavaScript代码的API文档。 YUIDoc是注释驱动的,并支持各种JavaScript编码风格。 YUIDoc的输出是API文档格式化为一组HTML页面,包括有关JavaScript对象的方法,属性,自定义事件和继承的信息。
YUIDoc
YUI Javascript文档工具。(YUI Javascript Documentation Tool. )
Github星跟踪图
YUIDoc最初是为YUI项目编写的; 它在生成的文件中使用YUI JavaScript和CSS,并且它支持常见的YUI约定,如自定义事件。 也就是说,它可以在非YUI代码上轻松有效地使用。
主要指标
- 概览
-
名称与所有者 yui/yuidoc 主编程语言 HTML 编程语言 Makefile (语言数: 6) 平台 许可证 Other - 所有者活动
-
创建于 2008-12-05 02:26:02 推送于 2019-11-06 20:37:31 最后一次提交 2017-04-17 21:29:43 发布数 66 最新版本名称 v0.10.2 (发布于 ) 第一版名称 yuidoc-2 (发布于 2008-12-01 16:18:55) - 用户参与
-
星数 889 关注者数 41 派生数 209 提交数 1.1k 已启用问题? 问题数 296 打开的问题数 122 拉请求数 119 打开的拉请求数 8 关闭的拉请求数 29 - 项目设置
-
已启用Wiki? 已存档? 是复刻? 已锁定? 是镜像? 是私有?
YUIDoc
YUI's JavaScript Documentation engine.
Overview
YUIDoc is a Node.js application used at build time to
generate API documentation for JavaScript code. YUIDoc is comment-driven and supports a wide
range of JavaScript coding styles. The output of YUIDoc is API documentation formatted as a
set of HTML pages including information about methods, properties, custom events and
inheritance for JavaScript objects.
YUIDoc was originally written for the YUI Project; it uses YUI JavaScript and CSS in the
generated files and it supports common YUI conventions like Custom Events. That said,
it can be used easily and productively on non-YUI code.
Installation
npm install -g yuidocjs
Documentation
Contributing
Please see the CONTRIBUTING.md.
License
This software is free to use under the Yahoo Inc. BSD license. See the LICENSE file for license text and copyright information.