phpcs 默认遵循 pear 或 psr 规范时会强制要求类注释中包含 `@license` 标签，但这对闭源项目并不适用；本文介绍通过配置排除该检查项的规范做法，避免添加无效标签污染代码。
在闭源 PHP 项目中使用 PHPCS（PHP CodeSniffer）进行代码质量检查时，若采用 PEAR 或某些基于 PSR 的规则集（如 PSR2/PSR12 的扩展配置），你可能会频繁遇到如下报错：
ERROR | Missing @license tag in class comment
| (PEAR.Commenting.ClassComment.MissingLicenseTag)该错误源于 PEAR 编码标准对类注释的硬性要求——必须显式声明 @license。但闭源项目无法也不应声明开源许可证（如 MIT、GPL），而填写 "No License"、"Proprietary" 或留空等做法不仅违背语义（@license 应指向真实法律授权条款），还会导致文档生成工具（如 phpDocumentor）误解析，甚至引发合规性误解。
✅ 推荐方案：禁用该 sniff，而非妥协注释
与其在每个类文件顶部强行添加无意义的 @license 标签，不如在 PHPCS 配置层面精准屏蔽该检查项。这是更专业、可维护且符合工程实践的做法。
步骤如下：
-
定位问题 sniff 名称
运行以下命令获取详细错误来源：vendor/bin/phpcs -s
输出中将明确显示触发错误的完整 sniff 名称，例如：
立即学习“PHP免费学习笔记（深入）”；
PEAR.Commenting.ClassComment.MissingLicenseTag
-
在 phpcs.xml（或 phpcs.xml.dist）中排除该规则
在你的项目根目录配置文件中，添加 <exclude> 指令：<?xml version="1.0"?> <ruleset name="MyProject"> <!-- 继承基础规则集，如 PEAR --> <rule ref="PEAR"> <!-- 关键：排除不适用于闭源场景的 license 检查 --> <exclude name="PEAR.Commenting.ClassComment.MissingLicenseTag"/> </rule> <!-- 指定扫描路径 --> <file>src</file> <file>tests</file> </ruleset> -
验证配置生效
重新运行 PHPCS：vendor/bin/phpcs
此前报出的 Missing @license 错误将不再出现，其余代码风格检查（如缩进、命名、括号格式等）仍保持严格校验。
⚠️ 注意事项：
- 不要使用 @license proprietary 或 @license closed-source —— 这些不是标准 SPDX 许可证标识符，且不具备法律效力；PHPCS 不校验其真实性，但会误导协作者与自动化工具。
- 若团队内部有定制化文档规范（如统一声明“© [Year] [Company] All Rights Reserved”），建议通过 @copyright 标签实现，它不受 PHPCS 强制约束，且语义准确。
- 后续升级 PHPCS 或切换规则集（如改用 PSR12）时，请再次确认是否引入同类检查，并按需更新 <exclude> 列表。
总结：代码规范工具服务于开发效率与协作质量，而非机械套用不匹配的教条。对闭源项目而言，合理裁剪规则比打补丁式注释更可持续、更专业。
