PHP - 注释



在任何计算机程序(例如PHP程序)中,注释都是一段解释性文本,会被语言编译器/解释器忽略。其目的是帮助用户理解程序算法中使用的逻辑。

虽然在代码中添加注释不是必需的,但它是一种强烈推荐的做法。注释也作为程序文档。当需要调试和修改代码时,注释也很有用。

PHP中有两种注释格式:

  • 单行注释

  • 多行注释

单行注释

它们通常用于对局部代码相关的简短解释或说明。PHP使用两种表示法在程序中插入单行注释。

使用“#”的单行注释

以“#”符号开头的PHP代码行被视为单行注释。

<?php
   # Single line comment starting with # symbol
   echo 'Hello World';
?>

使用“//”的单行注释

PHP也支持C风格的单行注释,使用“//”符号。以双斜杠符号开头的行被视为注释。

<?php
   // Single line comment starting with // symbol
   echo 'Hello World';
?>

以“#”或“//”符号开头的注释不需要关闭。这些符号的效果持续到物理行的末尾。

换句话说,即使没有结束注释标记,PHP解析器也会将下一行视为PHP语句,而不是注释。

多行注释

多行注释通常用于提供伪代码算法和必要时的更详细解释。

多行注释的风格与C语言相同。嵌入在“/*”和“*/”符号之间的一行或多行都被视为注释。

PHP中多行注释的示例

这是一个多行注释的示例。

<?php

   /* This is a multiline comment example
   program to add two numbers
   Variables used - $x for first number, 
   $y for second number */
   
   $x=10;
   $y=20;
   print "Total = ". $x+$y;
?>

请注意,您甚至可以将单行放在“/* .. */”符号内。但是,如果程序中存在“/*”符号,则必须有结束注释标记“*/”。如果没有,将会显示如下错误:

PHP Parse error:  Unterminated comment starting line 3 in /home/cg/root/65ded9eeb52fc/main.php on line 3
广告