
Rule align_multiline_comment
ΒΆ
Each line of multi-line DocComments must have an asterisk [PSR-5] and must be aligned with the first one.
ConfigurationΒΆ
ExamplesΒΆ
Example #1ΒΆ
Default configuration.
--- Original
+++ New
<?php
/**
- * This is a DOC Comment
-with a line not prefixed with asterisk
-
- */
+ * This is a DOC Comment
+ * with a line not prefixed with asterisk
+ *
+ */
Example #2ΒΆ
With configuration: ['comment_type' => 'phpdocs_like']
.
--- Original
+++ New
<?php
/*
- * This is a doc-like multiline comment
-*/
+ * This is a doc-like multiline comment
+ */
Example #3ΒΆ
With configuration: ['comment_type' => 'all_multiline']
.
--- Original
+++ New
<?php
/*
- * This is a doc-like multiline comment
+ * This is a doc-like multiline comment
with a line not prefixed with asterisk
- */
+ */
Rule setsΒΆ
The rule is part of the following rule sets:
comment_type
ΒΆWhether to fix PHPDoc comments only (
phpdocs_only
), any multi-line comment whose lines all start with an asterisk (phpdocs_like
) or any multi-line comment (all_multiline
).Allowed values:
'all_multiline'
,'phpdocs_like'
and'phpdocs_only'
Default value:
'phpdocs_only'