All items of the given phpdoc tags must be either left-aligned or (by default) aligned vertically.
The tags that should be aligned.
Allowed values: a subset of ['param', 'property', 'property-read', 'property-write', 'return', 'throws', 'type', 'var', 'method']
Default value: ['method', 'param', 'property', 'return', 'throws', 'type', 'var']
Align comments
Allowed values: 'left'
, 'vertical'
Default value: 'vertical'
Default configuration.
--- Original
+++ New
<?php
/**
- * @param EngineInterface $templating
- * @param string $format
- * @param int $code an HTTP response status code
- * @param bool $debug
- * @param mixed &$reference a parameter passed by reference
+ * @param EngineInterface $templating
+ * @param string $format
+ * @param int $code an HTTP response status code
+ * @param bool $debug
+ * @param mixed &$reference a parameter passed by reference
*/
With configuration: ['align' => 'vertical']
.
--- Original
+++ New
<?php
/**
- * @param EngineInterface $templating
- * @param string $format
- * @param int $code an HTTP response status code
- * @param bool $debug
- * @param mixed &$reference a parameter passed by reference
+ * @param EngineInterface $templating
+ * @param string $format
+ * @param int $code an HTTP response status code
+ * @param bool $debug
+ * @param mixed &$reference a parameter passed by reference
*/
With configuration: ['align' => 'left']
.
--- Original
+++ New
<?php
/**
- * @param EngineInterface $templating
- * @param string $format
- * @param int $code an HTTP response status code
- * @param bool $debug
- * @param mixed &$reference a parameter passed by reference
+ * @param EngineInterface $templating
+ * @param string $format
+ * @param int $code an HTTP response status code
+ * @param bool $debug
+ * @param mixed &$reference a parameter passed by reference
*/
The rule is part of the following rule sets:
- @PhpCsFixer
- Using the @PhpCsFixer rule set will enable the
phpdoc_align
rule with the default config. - @Symfony
- Using the @Symfony rule set will enable the
phpdoc_align
rule with the default config.