
no_superfluous_phpdoc_tags
¶Removes @param
, @return
and @var
tags that don’t provide any useful
information.
allow_mixed
¶Whether type mixed
without description is allowed (true
) or considered
superfluous (false
)
Allowed types: bool
Default value: false
allow_unused_params
¶Whether param
annotation without actual signature is allowed (true
) or
considered superfluous (false
)
Allowed types: bool
Default value: false
Default configuration.
--- Original
+++ New
<?php
class Foo {
/**
- * @param Bar $bar
- * @param mixed $baz
*
- * @return Baz
*/
public function doFoo(Bar $bar, $baz): Baz {}
}
With configuration: ['allow_mixed' => true]
.
--- Original
+++ New
<?php
class Foo {
/**
- * @param Bar $bar
* @param mixed $baz
*/
public function doFoo(Bar $bar, $baz) {}
}
With configuration: ['remove_inheritdoc' => true]
.
--- Original
+++ New
<?php
class Foo {
/**
- * @inheritDoc
+ *
*/
public function doFoo(Bar $bar, $baz) {}
}
With configuration: ['allow_unused_params' => true]
.
--- Original
+++ New
<?php
class Foo {
/**
- * @param Bar $bar
- * @param mixed $baz
* @param string|int|null $qux
*/
public function doFoo(Bar $bar, $baz /*, $qux = null */) {}
}
The rule is part of the following rule sets:
Using the @PhpCsFixer rule set will enable the no_superfluous_phpdoc_tags
rule with the config below:
['allow_mixed' => true, 'allow_unused_params' => true]
Using the @Symfony rule set will enable the no_superfluous_phpdoc_tags
rule with the config below:
['allow_mixed' => true, 'allow_unused_params' => true]