phpdoc_no_package.rst 686 B

123456789101112131415161718192021222324252627282930313233343536
  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,8 +1,6 @@
  13. <?php
  14. /**
  15. * @internal
  16. - * @package Foo
  17. - * subpackage Bar
  18. */
  19. class Baz
  20. {
  21. Rule sets
  22. ---------
  23. The rule is part of the following rule sets:
  24. @PhpCsFixer
  25. Using the `@PhpCsFixer <./../../ruleSets/PhpCsFixer.rst>`_ rule set will enable the ``phpdoc_no_package`` rule.
  26. @Symfony
  27. Using the `@Symfony <./../../ruleSets/Symfony.rst>`_ rule set will enable the ``phpdoc_no_package`` rule.