# RDoc::Comment - ri - phpman

= [**RDoc::Comment](https://www.chedong.com/phpMan.php/perldoc/RDoc%3A%3AComment/markdown) < Object**

------------------------------------------------------------------------
= **Includes:**
[RDoc::Text](https://www.chedong.com/phpMan.php/perldoc/RDoc%3A%3AText/markdown) (from gem rdoc-7.2.0)

(from gem rdoc-7.2.0)
------------------------------------------------------------------------
A comment holds the text comment for a [RDoc::CodeObject](https://www.chedong.com/phpMan.php/perldoc/RDoc%3A%3ACodeObject/markdown) and provides a
unified way of cleaning it up and parsing it into an
[RDoc::Markup::Document](https://www.chedong.com/phpMan.php/perldoc/RDoc%3A%3AMarkup%3A%3ADocument/markdown).

Each comment may have a different markup format set by #format=.  By
default 'rdoc' is used.  The :markup: directive tells RDoc which format
to use.

## See RDoc Markup Reference(
rdoc-ref:doc/markup_reference/rdoc.rdoc@Directive+for+Specifying+RDoc+So
urce+Format ).
------------------------------------------------------------------------
= **Constants:**

DIRECTIVE_OR_ESCAPED_DIRECTIV_REGEXP:
  [not documented]


= **Class methods:**

  new
  normalize_comment_lines
  parse
  take_multiline_directive_value_lines

= **Instance methods:**

  document
  empty?
  encode!
  extract_call_seq
  file
  format
  format=
  line
  location
  normalize
  normalized=
  parse
  remove_private
  text
  text=
  to_s
  tomdoc?

= **Attributes:**

  attr_accessor file
  attr_accessor line
  attr_accessor location
  attr_reader format
  attr_reader text
  attr_reader to_s
  attr_writer document