YARD──Ruby 代码元数据和文档生成器

<pre id="o3wo20"><span id="derf1"><span id="uyyx"># Reverses the contents of a String or IO object. </span></span><span id="uyyx0"><br id="o3wo21"></br># <br id="o3wo22"></br># @param [String, #read] contents the contents to reverse <br id="o3wo23"></br># @return [String] the contents reversed lexically <br id="o3wo24"></br>def reverse(contents) <br id="o3wo25"></br> contents = contents.read if respond_to? :read<br id="o3wo26"></br> contents.reverse <br id="o3wo27"></br>end </span>

在一个项目上使用 YARD 需要创建一个.yardoc 数据库，把所有收集到的代码结构和数据缓存起来。YARD 的 yri 工具，就像 ri 那 样，通过这个数据来做到交互式文档查询。YARD 也可以将缓存在数据库中的信息以多种格式输出，而不需要重复的分析。YARD 的缓存和 IDE 创建的代码索 引很相似，可以允许高级代码搜索（例如，搜索语言构成，而不仅仅是全文检索）、代码浏览，或者为那些需要关注工程中全部代码的重构工具的使用带来便利。