YUIDoc

YUI Javascript文档工具。(YUI Javascript Documentation Tool. )

Github星跟蹤圖

YUIDoc是在构建时使用的Node.js应用程序,用于生成JavaScript代码的API文档。 YUIDoc是注释驱动的,并支持各种JavaScript编码风格。 YUIDoc的输出是API文档格式化为一组HTML页面,包括有关JavaScript对象的方法,属性,自定义事件和继承的信息。

YUIDoc最初是为YUI项目编写的; 它在生成的文件中使用YUI JavaScript和CSS,并且它支持常见的YUI约定,如自定义事件。 也就是说,它可以在非YUI代码上轻松有效地使用。

概覽

名稱與所有者yui/yuidoc
主編程語言HTML
編程語言Makefile (語言數: 6)
平台
許可證Other
發布數66
最新版本名稱v0.10.2 (發布於 )
第一版名稱yuidoc-2 (發布於 2008-12-01 16:18:55)
創建於2008-12-05 02:26:02
推送於2019-11-06 20:37:31
最后一次提交2017-04-17 21:29:43
星數892
關注者數42
派生數211
提交數1.1k
已啟用問題?
問題數295
打開的問題數122
拉請求數119
打開的拉請求數9
關閉的拉請求數28
已啟用Wiki?
已存檔?
是復刻?
已鎖定?
是鏡像?
是私有?

YUIDoc

YUI's JavaScript Documentation engine.

npm Version
Build Status
Dependency Status

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.

去到頂部