PHP代码注释方式

PHP代码注释方式

对于阅读代码的人来说,注释其实就相当于代码的解释和说明。注释可以用来解释脚本的用途、脚本编写人、为什么要按如此的方法编写代码、上一次修改的时间等。通常,读者将在所有脚本中发现注释,最简单的脚本除外。

PHP解释器将忽略注释中的任何文本。事实上,PHP分析器将跳过等同于空格字符的注释。PHP支持C、C++和Shell脚本风格的注释。如下所示的是一个C风格的注释,多行注释可以出现在PHP脚本的开始处:

/* Author: feng

Last modified: April 10

This script processes the customer orders.

*/

多行注释应该以/*开始,*/为结束。与C语言相同,多行注释是去污嵌套的。你也可以使用C++风格的单行注释:

<?php

echo '<p>Order processed.</p> '; // Start printing order

?>

或者Shell脚本风格:

<?php

echo '<p>Order processed.</p> '; # Start printing order

?>

无论哪种风格的注释,在注释符号(#或//)之后行结束之前,或PHP结束标记之前的所有内容都是注释。

在如下所示的代码中,关闭标记之前的文本,"here is a comment"是注释的一部分。而关闭标记之后的文本,"here is not" 将被当作是HTML,因为它位于关闭标记之外。

// here is a comment ?> here is not

CGI工作流程如图

PHP代码注释方式