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

  • Werner Schuster
  • 李明(nasi)

2008 年 8 月 2 日

话题:RubyIDE语言 & 开发

# Reverses the contents of a String or IO object. 

#

# @param [String, #read] contents the contents to reverse

# @return [String] the contents reversed lexically

def reverse(contents)

contents = contents.read if respond_to? :read

 contents.reverse

end


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

RubyIDE语言 & 开发