从ruby文件+ YARD获取方法和注释

时间:2013-11-21 11:51:26

标签: ruby yard

好的我有一个任务,我必须从ruby文件中提取方法和注释,并将它们存储在db中作为参考

在此之前,我设法使用这段代码来实现相同的

module Describe
  def describe(method_name,description)
    @@method_descriptions ||= []
    @@method_descriptions << [method_name,description]
  end

  def method_descriptions
    Hash[@@method_descriptions]
  end
end

然后在类

中使用类似的东西
   class A
      extend Describe

      def call_me
      end
      describe :call_me,"This method is you to invoke"
   end 

但事实上,我必须为此编写一些代码,而且它们不是实际的评论

我可以用YARD实现同样的目标

1 个答案:

答案 0 :(得分:0)

YARD使用RDoc的增强表示法,因此至少可以将文档编写为方法上方的注释。

YARD的原始输出数据可以存储在数据库中。至少,这就是Feature list声称的内容。