在使用 PHP-CS-Fixer 进行代码风格检查和修复时，AdamWojs/php-cs-fixer-one-line-var-phpdoc 是一个非常有用的自定义规则。它可以确保当没有额外的描述时，@var PHPDoc 注释保持在单行内，从而提高代码的整洁性和一致性。
要使用这个规则，首先需要通过 Composer 安装 AdamWojs/php-cs-fixer-one-line-var-phpdoc：
composer require adamwojs/php-cs-fixer-one-line-var-phpdoc
安装完成后，你可以在 .php_cs 文件中配置这个规则。以下是配置的示例：
<?php
// PHP-CS-Fixer 2.x 语法
return PhpCsFixer\Config::create()
// (1) 注册 \AdamWojs\PhpCsFixerSingleLineVarPhpdoc\Fixer\Phpdoc\SingleLineVarPhpDocFixer fixer
->registerCustomFixers([
new \AdamWojs\PhpCsFixerSingleLineVarPhpdoc\Fixer\Phpdoc\SingleLineVarPhpDocFixer(),
])
->setRules([
// ...
// (2) 启用 AdamWojs/phpdoc_force_single_line_var 规则
'AdamWojs/phpdoc_force_single_line_var' => true,
])
// ...
;通过以上配置，PHP-CS-Fixer 会在代码检查和修复过程中自动将没有额外描述的 @var PHPDoc 注释转换为单行格式。例如：
立即学习“PHP免费学习笔记（深入）”；
/** * @var string */ private $name; // 将被转换为： /** @var string */ private $name;
使用这个规则后，我发现团队的代码风格变得更加统一，审查和维护工作也变得更加简单。AdamWojs/php-cs-fixer-one-line-var-phpdoc 不仅提高了代码的可读性，还减少了因格式不一致而导致的错误。它是一个简单但有效的工具，非常适合那些重视代码质量和一致性的开发团队。
以上就是简化代码注释：使用 AdamWojs/php-cs-fixer-one-line-var-phpdoc 规则的详细内容，更多请关注php中文网其它相关文章！
PHP怎么学习？PHP怎么入门？PHP在哪学？PHP怎么学才快？不用担心，这里为大家提供了PHP速学教程(入门到精通)，有需要的小伙伴保存下载就能学习啦！
广告
收藏
收藏
收藏
Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号
325
