PHP的注释

页面分类: PHP | 程序注释

天下维客，你可以修改的网络知识库

在PHP代码中合理书写注释，可以使程序更容易阅读，也可以记录算法等重要事项避免遗忘。

PHP代码中的注释不仅不会影响执行结果，而且注释不会影响PHP代码运行效率，因此可以放心写下较多的注释。

PHP有三种注释方式，参见下面的例子：

<?php
<span style="color: #808080;">/*****************************************************************
 * 多行注释（C风格）
 *****************************************************************/</span>
    echo '上面是多行注释的示例';
 
    echo '行注释-1';  // 这是C++风格的行注释，以双斜线开始
    echo '行注释-2';  # 这是Unix Shell或者Perl风格的行注释，以#开始
?>

几点说明

多行注释（块注释）

在PHP中，块注释以“/*”引导，碰到第一个“*/”时结束。

块注释不允许嵌套！。由于不进行块注释的嵌套检查，因此下面的写法是错误的：

<?php
 <span style="color: #808080;">/*
    echo "This is a test"; /* 块注释的嵌套将引起错误*/</span>
 */
?>

单行注释

单行注释以“//”或者“#”引导，碰到换行或者PHP结束标记时结束。

如果单行注释中包含“?>”，则其后的字符将被作为HTML内容处理，例如：

<h1>This is an <?php # echo "simple";?> example.</h1>
<p>上面的h1标签中的有效内容实际等同于'This is an example'。

参考资料