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

php注释种类有哪些类型

注释 多行 单行 代码 382    来源:    2025-03-16

在PHP中,注释用于在代码中添加说明或注解,这些注释不会被PHP解释器执行。PHP支持以下几种类型的注释:

  1. 单行注释

    • 使用 //# 来注释单行代码。
    • 示例: php // 这是一个单行注释 # 这也是一个单行注释 $var = 10; // 这行代码设置变量 $var 的值为 10
  2. 多行注释

    • 使用 /**/ 来注释多行代码或一段代码。
    • 示例: php /* 这是一个多行注释 可以跨越多行 */ $var = 20; /* 这行代码设置变量 $var 的值为 20 */
  3. 文档注释(DocBlock):

    • 使用 /***/ 来注释类、方法、属性等,通常用于生成文档。
    • 文档注释可以包含标签(如 @param, @return, @throws 等)来提供更详细的信息。
    • 示例: ```php /**
      • 这是一个示例类
      • @package MyPackage
      • @author John Doe */ class MyClass { /**
        • 这是一个示例方法
        • @param int $a 第一个参数
        • @param int $b 第二个参数
        • @return int 返回两个参数的和 */ public function add($a, $b) { return $a + $b; } } ```

总结

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

这些注释类型可以帮助开发者更好地理解和维护代码,同时文档注释还可以用于生成API文档。