JavaScript API文档生成工具 YUI Doc

BSD
Python JavaScript
跨平台
2009-10-16
红薯

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

生成的文档效果:

Click for a larger image

示例语法:

/**
* 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
*/

YUIDoc 提供:

  • 即时预览
  • 流行的标注
  • 支持多种语言

其他特性:

  • 注释支持 Markdown 语法
  • Support for many more tags out of the box
  • Logic separated to allow for easy extensibility
  • Better theming support
  • Server mode for development time previews
  • External data mixing
  • Easy cross platform installation
  • Cross-linking inside and out of current project
  • JSON based configuration
加载中

评论(0)

暂无评论

YUI Doc 0.3.1 发布,JavaScript 文档工具

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

2012/05/10 14:45

没有更多内容

加载失败,请刷新页面

没有更多内容

1
回答
有多少程序员写代码是用doclet(文档生成工具)的?

我走查了公司程序员们的代码,让我吐血数升,折寿10载。 80%的代码 一点说明都没有~~

2016/12/13 13:00

没有更多内容

加载失败,请刷新页面

没有更多内容

Javascript代码及注释规范

Javascript代码及注释规范 为规范前端开发代码,提高代码质量,特制定此文档,其中声明,安全和分号这三节是必须执行的,组件类必须遵循注释规范。 声明 变量声明必须加var关键字,严格控制作...

2014/05/16 22:14
292
0
[JavaScript]项目优化总结

前段时间对公司已有项目JavaScript代码进行优化,本文的是对优化工作的一个总结,拿出来与大家分享。 当然我的优化方式可能并不是最优的,或者说有些不对的地方,请指教。 ## JavaScript优化...

2012/12/19 16:31
259
0
好程序员web前端分享7个步骤:让JavaScript变得更好

好程序员web前端分享7个步骤:让JavaScript变得更好,随着浏览器性能提高,伴随着新的HTML5的编程接口的稳步采用,网页上的JavaScript的音量在逐渐增加。然而,一个写得不好的程序编码却拥有...

昨天 16:27
7
0
javascript模式 读书笔记一

第一章 简介 模式 模式是指一个通用问题的解决方案。 模式分三种 设计模式 编码模式:javascript特有的 反模式:常见的 引发的问题比解决的问题更多的一种方法。 JavaScript:基本概念 面向对...

2014/01/21 10:24
151
0
JavaScript开发工具大全

译者按: 最全的JavaScript开发工具列表,总有一款适合你! 原文: THE ULTIMATE LIST OF JAVASCRIPT TOOLS 译者: Fundebug 为了保证可读性,本文采用意译而非直译。另外,本文版权归原作者所有...

2017/06/19 14:52
20
0
工具:使用过的 API 文档生成工具

背景 2012 年之前几乎没有为代码增加注释,当然,代码的命名也不见得合理(好的代码胜过面面俱到的注释),后来接触过一些开源框架,优秀的框架都有一个特点:文档和示例非常多,在后来的日子...

2016/04/12 10:36
79
1
npm 常见操作

常用命令 列出配置: npm config ls 设置淘宝npm: npm config set registry "https://registry.npm.taobao.org" 给全局模块设置环境变量 比方说,我使用npm全局安装yuidoc,但在cmd无法直接使...

2016/11/22 10:56
26
0
Web前端工程师之路(一)-技术

HTML 按性质分 Block-Level和Inline-Level 按语义分 Headings: h1, h2, h3, h4, h5, h6 Paragraphs: p Text Formatting: em, strong, sub, del, ins, small Lists: ul, li, ol, dl, dt, dd T...

2014/03/28 00:26
105
1
sublime text 3 插件:DocBlockr与javascript注释规范

http://www.cnblogs.com/huangtailang/p/4499988.html Sublime2 DocBlocker插件在自动补全注释时输出自定义作者和当前时间等信息 配置信息: { "jsdocs_extra_tags":["@AuthorHTL","@DateTi...

2016/05/15 16:51
374
2
JavaScript注释规范

注释写的好,爹妈跟着好

2016/07/27 17:49
48
0

没有更多内容

加载失败,请刷新页面

返回顶部
顶部