phpdoc_annotation_without_dot.rst 562 B

12345678910111213141516171819202122232425262728293031
  1. ======================================
  2. Rule ``phpdoc_annotation_without_dot``
  3. ======================================
  4. PHPDoc annotation descriptions should not be a sentence.
  5. Examples
  6. --------
  7. Example #1
  8. ~~~~~~~~~~
  9. .. code-block:: diff
  10. --- Original
  11. +++ New
  12. <?php
  13. /**
  14. - * @param string $bar Some string.
  15. + * @param string $bar some string
  16. */
  17. function foo ($bar) {}
  18. Rule sets
  19. ---------
  20. The rule is part of the following rule sets:
  21. - `@PhpCsFixer <./../../ruleSets/PhpCsFixer.rst>`_
  22. - `@Symfony <./../../ruleSets/Symfony.rst>`_