Skip to content
Extract Comments from Ruby Code
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
spec
.gitignore
.rspec
.travis.yml
Gemfile
LICENSE
README.md
Runfile
getcomments.gemspec

README.md

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

require 'getcomments'
comments = GetComments::Read.from 'filename.rb'
p comments

# => {
#      "module TestModule" => "This is the module comment",
#      "class TestClass"   => "This is the class comment",
#      "def some_method"   => "This is a multiline\nmethod comment"
#    }
You can’t perform that action at this time.