插件窝 干货文章 php注释的种类有哪些

php注释的种类有哪些

注释 多行 单行 文档 732    来源:    2025-03-16

在PHP中,注释是用来对代码进行说明或解释的文本,这些注释不会被PHP解释器执行。PHP支持以下几种注释方式:

  1. 单行注释

    • 使用双斜杠 // 进行单行注释。从 // 开始到行尾的内容都会被当作注释。 php // 这是一个单行注释 $var = 10; // 这也是一个单行注释
  2. 多行注释

    • 使用 /**/ 进行多行注释。/**/ 之间的所有内容都会被当作注释。 php /* 这是一个多行注释 可以跨越多行 */ $var = 20;
  3. 文档注释

    • 使用 /***/ 进行文档注释。这种注释通常用于生成API文档,常见的工具如PHPDocumentor会解析这种注释。 ```php /**
      • 这是一个文档注释
      • 通常用于描述类、方法或函数的用途
      • @param int $param 这是一个参数
      • @return void */ function exampleFunction($param) { // 函数体 } ```
  4. Shell风格的注释

    • 使用 # 进行单行注释。从 # 开始到行尾的内容都会被当作注释。 php # 这是一个Shell风格的注释 $var = 30; # 这也是一个Shell风格的注释

总结

  • 单行注释://#
  • 多行注释:/* ... */
  • 文档注释:/** ... */

这些注释方式可以根据需要选择使用,通常单行注释用于简短的说明,多行注释用于较长的解释,而文档注释则用于生成API文档。