在使用 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 PhpCsFixerConfig::create() // (1) 注册 AdamWojsPhpCsFixerSingleLineVarPhpdocFixerPhpdocSingleLineVarPhpDocFixer fixer ->registerCustomFixers([ new AdamWojsPhpCsFixerSingleLineVarPhpdocFixerPhpdocSingleLineVarPhpDocFixer(), ]) ->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 不仅提高了代码的可读性，还减少了因格式不一致而导致的错误。它是一个简单但有效的工具，非常适合那些重视代码质量和一致性的开发团队。
© 版权声明
文章版权归作者所有，未经允许请勿转载。
THE END
