class Prism::Comment

要約

Prism::ParseResult#comments や Prism?.parse_comments で得られる、ソースコード中のコメントを表す抽象基底クラスです。

実際に生成されるのはサブクラスの Prism::InlineComment(# から始まる通常のコメント)または Prism::EmbDocComment(=begin 〜 =end の埋め込みドキュメント)のどちらかで、このクラス自体のインスタンスが返されることはありません。

[SEE_ALSO] Prism::ParseResult#comments, Prism?.parse_comments

目次

インスタンスメソッド

• deconstruct_keys
• location
• slice

インスタンスメソッド

deconstruct_keys(keys) -> HashRuby 3.3 から[permalink][rdoc][edit]

パターンマッチのハッシュパターン(case comment; in {location:})で使われます。location をキーに持つハッシュを返します。

[PARAM] keys:

取り出したいキーの配列を指定します。すべて取り出す場合は nil を指定します。

例

require "prism"

comment = Prism.parse("# hello\n1 + 1").comments.first
case comment
in {location:}
  p location.slice
end
# => "# hello"

location -> Prism::LocationRuby 3.3 から[permalink][rdoc][edit]

コメントのソースコード上の位置を表す Prism::Location を返します。コメントの文字列そのものは location.slice で取得できます。

例

require "prism"

comment = Prism.parse("# hello\n1 + 1").comments.first
p comment.location.start_line # => 1
p comment.location.slice      # => "# hello"

slice -> StringRuby 3.4 から[permalink][rdoc][edit]

コメントの文字列そのものを返します。location.slice の短縮形です。

例

require "prism"

comment = Prism.parse("# hello\n1 + 1").comments.first
p comment.slice # => "# hello"