JavaScript API文档生成工具 YUI Doc 0.3.1 发布
fmms 13年前
<p><a href="/misc/goto?guid=4958339507881089026" target="_blank">YUI Doc </a>0.3.1 发布了,YUIDoc 是一个基于 Node.js 的应用程序,用来根据 JavaScript 的注释中生成 API 文档,类似 JavaDoc,这也是当前 YUI 用来生成文档的工具。</p> <p>生成的文档效果:</p> <p><img border="0" alt="JavaScript API文档生成工具 YUI Doc" src="https://simg.open-open.com/show/73fa4f7e81ceb6fed6b66375cdf5df1e.jpg" width="524" height="255" /></p> <p>示例语法:</p> <pre class="brush:javascript; toolbar: true; auto-links: false;">/** * 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 */</pre> <p></p> <h3>YUIDoc 提供:</h3> <ul> <li><strong>即时预览</strong></li> <li><strong>流行的标注</strong></li> <li><strong>支持多种语言</strong></li> </ul> <p>其他特性:</p> <ul> <li>注释支持 Markdown 语法</li> <li>Support for many more tags out of the box</li> <li>Logic separated to allow for easy extensibility</li> <li>Better theming support</li> <li>Server mode for development time previews</li> <li>External data mixing</li> <li>Easy cross platform installation</li> <li>Cross-linking inside and out of current project</li> <li>JSON based configuration</li> </ul> <p></p>