phpdoc_annotation_without_dot.rst 752 B

12345678910111213141516171819202122232425262728293031323334
  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. @@ -1,5 +1,5 @@
  13. <?php
  14. /**
  15. - * @param string $bar Some string.
  16. + * @param string $bar some string
  17. */
  18. function foo ($bar) {}
  19. Rule sets
  20. ---------
  21. The rule is part of the following rule sets:
  22. @PhpCsFixer
  23. Using the `@PhpCsFixer <./../../ruleSets/PhpCsFixer.rst>`_ rule set will enable the ``phpdoc_annotation_without_dot`` rule.
  24. @Symfony
  25. Using the `@Symfony <./../../ruleSets/Symfony.rst>`_ rule set will enable the ``phpdoc_annotation_without_dot`` rule.