minor #9211 Recommend to never inline PHPDoc blocks (javiereguiluz)

javiereguiluz · javiereguiluz · commit 1a0c5fa8d3ad · 2018-02-07T09:12:05.000+01:00
This PR was merged into the 2.7 branch. Discussion ---------- Recommend to never inline PHPDoc blocks I guess the existing recommendation is wrong because we never do that in the Symfony code. See https://github.com/symfony/symfony/search?utf8=%E2%9C%93&q=%7B%40inheritdoc%7D&type= Commits ------- 3391e51 Recommend to never inline PHPDoc blocks
diff --git a/contributing/code/standards.rst b/contributing/code/standards.rst
@@ -251,7 +251,8 @@ Documentation
 
 * The ``@package`` and ``@subpackage`` annotations are not used;
 
-* Inline the ``@inheritdoc`` tag.
+* Don't inline PHPDoc blocks, even when they contain just one tag (e.g. don't
+  put ``/** {@inheritdoc} */`` in a single line).
 
 License
 ~~~~~~~
