注释应解释代码背后的逻辑而非功能，使用PHPDoc规范说明函数参数、返回值及异常，重点描述“为什么”如此实现，避免冗余或过时内容，合理运用行内注释辅助理解复杂逻辑。
写好注释不是为了告诉代码做了什么，而是解释为什么这么做。清晰的注释能大幅提升PHP代码的可读性和维护效率。以下是一些实用且被广泛认可的注释最佳实践。
使用清晰的函数和类级注释
每个函数或方法都应有简明扼要的注释，说明其功能、参数、返回值及可能抛出的异常。推荐使用PHPDoc风格，便于生成文档或被IDE识别。
- 用
@param标明参数类型和用途 - 用
@return说明返回值类型和含义 - 必要时添加
@throws指出异常情况
示例：
/**
* 计算用户折扣后的价格
*
* @param float $price 原始价格
* @param string $userType 用户类型：'vip', 'regular'
* @return float 折扣后价格
* @throws InvalidArgumentException 当用户类型无效时
*/
function calculateDiscount(float $price, string $userType): float
{
if (!in_array($userType, ['vip', 'regular'])) {
throw new InvalidArgumentException('无效的用户类型');
}
return $userType === 'vip' ? $price * 0.8 : $price;
}
解释“为什么”而不是“做什么”
代码本身已经说明了“做什么”，注释应聚焦于背后的逻辑或决策原因。
立即学习“PHP免费学习笔记（深入）”；
- 记录特殊处理的原因，比如兼容旧数据格式
- 说明为何选择某个算法或第三方库
- 标记临时方案或待优化项（配合TODO）
例如：
// 由于老系统导出的数据缺少时区信息，此处强制设为UTC
$dateTime = new DateTime($timestamp, new DateTimeZone('UTC'));
避免冗余和过时注释
无意义的注释会干扰阅读，比如“设置变量值”这类显而易见的操作无需注释。更危险的是代码修改后未更新注释，导致误导。
- 删除无实际价值的注释，如
// 循环开始 - 修改代码时顺手检查相关注释是否仍准确
- 不要用大段注释“注释掉”代码，应直接删除并用版本控制管理
合理使用行内注释
行内注释放在代码右侧，用于快速解释复杂表达式或关键判断。
注意保持间距，避免影响代码对齐。只在必要时使用。
if ($user->getLoginCount() > 1 && !$user->hasCompletedProfile()) {
// 登录超过一次但资料未完善，触发提醒
$this->sendReminder($user);
}
基本上就这些。好的注释像路标，让人快速理解代码意图而不必逐行推演。坚持写有意义的注释，团队协作和后期维护都会轻松很多。
