Tested with {@inheritdoc} and {@inheritDoc}; possible regression of #214

Never mind, you learn something new every day.

Not sure why this was closed. There's currently no open issue regarding inheritdoc

Seems like like if the sniff had a $skipIfInheritdoc (default false) option, everyone would be happy

$skipIfInheritdoc would address the common use case

    /**
     * {@inheritdoc}
     */

I closed this issue after reading the PHP doc documentation, CS works according to the specification as it currently is. @inheritdoc is only for the title and description.

https://docs.phpdoc.org/latest/guides/inheritance.html

However, it does make clear that an element has been explicitly documented (and thus not forgotten). As such we are working to include a new (normal) tag in the PHPDoc Standard @inheritdoc that will serve that purpose.

8 years have passed...

That may be the "official" specification, but the community has adopted it to include the the entire parent comment if the comment consists only of @inheritdoc

a non-exhaustive list of IDEs / frameworks / projects that use it for this purpose

• eclipse,
• Netbeans
• Drupal
• PhpStorm
• slim framework
• Symfony
• Yii2

Can this be reopened and supported? Basically any documentation builder (including phpDocumentor), framework and modern IDE supports @inheritDoc and {@inheritDoc}. It feels really unnececary to duplicate all docblocks if they are already documented in parent, requiring more maintaince and possibly causing outdated definitions or even more problems.

It would be nice if PHPCS could actually detect if all parent's parameters are correct or not and also reflect than on children, but option to just ignore detection of missing/incomplite tags (but not other docblock detections) if @inheritDoc is present in docblock would also probably be ok.

Also, maybe a bit newer standard is PSR-19 draft which specified:

In addition to the inherited descriptions and tags as defined in this chapter's root, a function or method in a class or interface MUST inherit the following tags:

• @param
• @return
• @throws

A $skipIfInheritdoc option seems like a great solution to this, given that this feature request has been made over and over for years on various docblock-related sniffs.

Reopened the issue for clarification from devs.

#3051 solves this for me locally. Example usage for testing:

    <rule ref="Squiz.Commenting.FunctionComment">                               
        <properties>
            <property name="skipIfInheritdoc" value="true"/>
        </properties>
    </rule>

This has now been resolved by the sniff property added in #3051, and documented here: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Customisable-Sniff-Properties#squizcommentingfunctioncomment

Not working for me. Even with skipIfInheritDoc still reports Squiz.Commenting.FunctionComment.MissingParamTag.

Not working for me. Even with skipIfInheritDoc still reports Squiz.Commenting.FunctionComment.MissingParamTag.

This new option is unreleased and not available in 3.5.8. This will become available when 3.6.0 is released.

Oh! I just assumed there'd be a releaase since mid-january this year. What about making a beta release with this? :)