class Ruby::Prism::Comment

This represents a comment that was encountered during parsing. It is the base class for all comment types.

Attributes

The Location of this comment in the source.

Public Class Methods

Create a new comment object with the given location.

: (Location location) -> void

# File lib/ruby/prism/parse_result.rb, line 710
def initialize(location)
  @location = location
end

Public Instance Methods

slice ()

Returns the content of the comment by slicing it from the source code.

: () -> String

# File lib/ruby/prism/parse_result.rb, line 724
def slice
  location.slice
end

trailing? ()

Returns true if this comment happens on the same line as other code and false if the comment is by itself. This can only be true for inline comments and should be false for block comments.

: () -> bool

# File lib/ruby/prism/parse_result.rb, line 733
def trailing?
  raise NotImplementedError, "trailing? is not implemented for #{self.class}"
end