JavaScript API文檔生成工具 YUI Doc 0.3.1 發布

fmms 12年前發布 | 13K 次閱讀 JavaScript

YUI Doc 0.3.1 發布了,YUIDoc 是一個基于 Node.js 的應用程序,用來根據 JavaScript 的注釋中生成 API 文檔,類似 JavaDoc,這也是當前 YUI 用來生成文檔的工具。

生成的文檔效果:

JavaScript API文檔生成工具 YUI Doc

示例語法:

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

 本文由用戶 fmms 自行上傳分享,僅供網友學習交流。所有權歸原作者,若您的權利被侵害,請聯系管理員。
 轉載本站原創文章,請注明出處,并保留原始鏈接、圖片水印。
 本站是一個以用戶分享為主的開源技術平臺,歡迎各類分享!