Laravel Pint格式化时注释@标签间自动换行如何禁用?
解决Laravel Pint格式化PHPDoc标签时添加空行的问题
问题根源:这个空行是由PHP-CS-Fixer的
phpdoc_separation规则导致的,该规则默认会给不同类型的PHPDoc标签之间插入空行。解决方案有两种:
1. 直接禁用该规则
在项目根目录的pint.json或pint.php配置文件中,将phpdoc_separation规则设为false:
使用pint.json的配置示例:
{ "rules": { "phpdoc_separation": false } }
使用pint.php的配置示例:
<?php return [ 'rules' => [ 'phpdoc_separation' => false, ], ];
2. 精细配置标签分组(推荐)
如果不想完全禁用标签分隔,可将需要放在一起的标签归为同一组,同一组内的标签之间不会被添加空行:
<?php return [ 'rules' => [ 'phpdoc_separation' => [ 'groups' => [ ['@description', '@author', '@email'], ['param', 'return'], ['throws', 'deprecated'], ], ], ], ];
这样@description、@author、@email之间不会出现空行,同时其他不同类型的标签(比如参数和返回值)仍会保持分隔,兼顾代码风格统一和你的需求。
内容的提问来源于stack exchange,提问作者Arafath
相关产品推荐
相关产品推荐

