<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Comments</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="language.basic-syntax.instruction-separation.html">Instruction separation</a></div>
<div class="next" style="text-align: right; float: right;"><a href="language.types.html">Types</a></div>
<div class="up"><a href="language.basic-syntax.html">Basic syntax</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="language.basic-syntax.comments" class="sect1">
<h2 class="title">Comments</h2>
<p class="para">
PHP supports 'C', 'C++' and Unix shell-style (Perl style) comments. For example:
<div class="informalexample">
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /> </span><span style="color: #007700">echo </span><span style="color: #DD0000">'This is a test'</span><span style="color: #007700">; </span><span style="color: #FF8000">// This is a one-line c++ style comment<br /> /* This is a multi line comment<br /> yet another line of comment */<br /> </span><span style="color: #007700">echo </span><span style="color: #DD0000">'This is yet another test'</span><span style="color: #007700">;<br /> echo </span><span style="color: #DD0000">'One Final Test'</span><span style="color: #007700">; </span><span style="color: #FF8000"># This is a one-line shell-style comment<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
<p class="simpara">
The "one-line" comment styles only comment to the end of
the line or the current block of PHP code, whichever comes first.
This means that HTML code after <em>// ... ?></em>
or <em># ... ?></em> WILL be printed:
?> breaks out of PHP mode and returns to HTML mode, and
<em>//</em> or <em>#</em> cannot influence that.
If the <a href="ini.core.html#ini.asp-tags" class="link">asp_tags</a> configuration directive
is enabled, it behaves the same with <em>// %></em> and
<em># %></em>.
However, the <em></script></em> tag doesn't break out of PHP mode in
a one-line comment.
</p>
<p class="para">
<div class="informalexample">
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<h1>This is an <span style="color: #0000BB"><?php </span><span style="color: #FF8000"># echo 'simple';</span><span style="color: #0000BB">?></span> example</h1><br /><p>The header above will say 'This is an example'.</p></span>
</code></div>
</div>
</div>
</p>
<p class="simpara">
'C' style comments end at the first <em>*/</em> encountered.
Make sure you don't nest 'C' style comments. It is easy to make this
mistake if you are trying to comment out a large block of code.
</p>
<p class="para">
<div class="informalexample">
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /> </span><span style="color: #FF8000">/*<br /> echo 'This is a test'; /* This comment will cause a problem */<br /> </span><span style="color: #007700">*/<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="language.basic-syntax.instruction-separation.html">Instruction separation</a></div>
<div class="next" style="text-align: right; float: right;"><a href="language.types.html">Types</a></div>
<div class="up"><a href="language.basic-syntax.html">Basic syntax</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
