php 中的注释类型
php 支持三种类型的注释：
-
单行注释
单行注释用于注释掉代码中的单行或部分行。您可以使用 // 或 # 来表示单行注释。 -
多行注释
多行注释，也称为块注释，用于注释掉多行代码。它们以 /* 开头，以 */ 结尾。当您需要暂时禁用大块代码或编写更长的解释时，这种类型的注释非常有用。 -
文档注释
文档注释是多行注释的一种特殊形式。它们以 /** 开头，通常用于使用 phpdoc 等工具生成文档。这种类型的注释通常放置在函数、类或方法之上，以描述它们的用途、参数和返回值。
@param 和 @return 注释提供元数据，文档生成器可以使用这些元数据来生成结构良好且详细的文档。
使用评论的最佳实践
保持评论相关且最新：过时的评论可能比没有评论更令人困惑。当您更改代码时，请务必更新您的评论。
避免明显的注释：像 $i++ 这样的代码行上方 // increment by 1 之类的注释；是不必要的。注释应该通过解释代码为什么做某事而不是它做了什么来增加价值。
对函数和类使用文档注释：这可以帮助您和其他人了解函数或类的作用、它接受哪些参数以及返回什么。
使用注释来解释复杂的逻辑：如果您的代码包含复杂的逻辑或算法，请使用注释来分解它并解释您的方法背后的推理。