phpdoc_no_package.rst 629 B

12345678910111213141516171819202122232425262728293031323334353637
  1. ==========================
  2. Rule ``phpdoc_no_package``
  3. ==========================
  4. ``@package`` and ``@subpackage`` annotations should be omitted from PHPDoc.
  5. Examples
  6. --------
  7. Example #1
  8. ~~~~~~~~~~
  9. .. code-block:: diff
  10. --- Original
  11. +++ New
  12. @@ -1,9 +1,7 @@
  13. <?php
  14. /**
  15. * @internal
  16. - * @package Foo
  17. - * subpackage Bar
  18. */
  19. class Baz
  20. {
  21. }
  22. Rule sets
  23. ---------
  24. The rule is part of the following rule sets:
  25. @Symfony
  26. Using the ``@Symfony`` rule set will enable the ``phpdoc_no_package`` rule.
  27. @PhpCsFixer
  28. Using the ``@PhpCsFixer`` rule set will enable the ``phpdoc_no_package`` rule.