phpdoc_summary.rst

Rule phpdoc_summary

PHPDoc summary should end in either a full stop, exclamation mark, or question mark.

Examples

Example #1

--- Original
+++ New
 <?php
 /**
- * Foo function is great
+ * Foo function is great.
  */
 function foo () {}

Rule sets

The rule is part of the following rule sets:

• @PhpCsFixer
• @Symfony

References

• Fixer class: PhpCsFixer\Fixer\Phpdoc\PhpdocSummaryFixer
• Test class: PhpCsFixer\Tests\Fixer\Phpdoc\PhpdocSummaryFixerTest

The test class defines officially supported behaviour. Each test case is a part of our backward compatibility promise.