GetComments - Extract Comments from Ruby Code

Gem Version Build Status Maintainability

This library provides an easy way to extract comments from a ruby source file.

Install

$ gem install getcomments

Or with bundler:

gem 'getcomments'

Usage

Get comments from a file:

# GetComments.from_file
require 'getcomments'
comments = GetComments.from_file 'spec/fixtures/minimal.rb'
comments.each do |key, value|
  puts "#{key}: #{value}"
end

#=> module TestModule: Module comment
#=> class TestClass: Class comment
#=> attr_reader :some_attr: Attribute comment
#=> def some_method: Method comment

Get coimments from a string:

# GetComments.from_string
code = "  # This function just sits here\n  def the_function\n  end\n"

comments = GetComments.from_string code
comments.each do |key, value|
  puts "#{key}: #{value}"
end

#=> def the_function: This function just sits here