.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "PPI::Token::Comment 3pm"
.TH PPI::Token::Comment 3pm "2019-07-21" "perl v5.28.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
PPI::Token::Comment \- A comment in Perl source code
.SH "INHERITANCE"
.IX Header "INHERITANCE"
.Vb 3
\&  PPI::Token::Comment
\&  isa PPI::Token
\&      isa PPI::Element
.Ve
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  # This is a PPI::Token::Comment
\&  
\&  print "Hello World!"; # So it this
\&  
\&  $string =~ s/ foo  # This, unfortunately, is not :(
\&        bar
\&        /w;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
In \s-1PPI,\s0 comments are represented by \f(CW\*(C`PPI::Token::Comment\*(C'\fR objects.
.PP
These come in two flavours, line comment and inline comments.
.PP
A \f(CW\*(C`line comment\*(C'\fR is a comment that stands on its own line. These comments
hold their own newline and whitespace (both leading and trailing) as part
of the one \f(CW\*(C`PPI::Token::Comment\*(C'\fR object.
.PP
An inline comment is a comment that appears after some code, and
continues to the end of the line. This does \fBnot\fR include whitespace,
and the terminating newlines is considered a separate
PPI::Token::Whitespace token.
.PP
This is largely a convenience, simplifying a lot of normal code relating
to the common things people do with comments.
.PP
Most commonly, it means when you \f(CW\*(C`prune\*(C'\fR or \f(CW\*(C`delete\*(C'\fR a comment, a line
comment disappears taking the entire line with it, and an inline comment
is removed from the inside of the line, allowing the newline to drop
back onto the end of the code, as you would expect.
.PP
It also means you can move comments around in blocks much more easily.
.PP
For now, this is a suitably handy way to do things. However, I do reserve
the right to change my mind on this one if it gets dangerously
anachronistic somewhere down the line.
.SH "METHODS"
.IX Header "METHODS"
Only very limited methods are available, beyond those provided by our
parent PPI::Token and PPI::Element classes.
.SS "line"
.IX Subsection "line"
The \f(CW\*(C`line\*(C'\fR accessor returns true if the \f(CW\*(C`PPI::Token::Comment\*(C'\fR is a
line comment, or false if it is an inline comment.
.SH "SUPPORT"
.IX Header "SUPPORT"
See the support section in the main module.
.SH "AUTHOR"
.IX Header "AUTHOR"
Adam Kennedy <adamk@cpan.org>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2001 \- 2011 Adam Kennedy.
.PP
This program is free software; you can redistribute
it and/or modify it under the same terms as Perl itself.
.PP
The full text of the license can be found in the
\&\s-1LICENSE\s0 file included with this module.