Add automatic {@inheritdoc} insertion.

Question

Add automatic {@inheritdoc} insertion.

Opened this issue 8 years ago · 6 comments

This would be really convenient, as atm I keep generating the default then deleting it and manually writing {@inheritdoc}. This should happen when interface method implemented or method overridden with same parameters.

Answer 1 · 2017-11-16T00:33:32.000Z

I've added a new fix/suggestion for the upcoming version that will allow to replace a docblock directly with an inheritdoc.
I'm not sure whether/how to override the existing default behavior of the PHP plugin so that's probably the quickest win atm.
It should be released together with the next phpstorm release.

Answer 2 · 2019-04-02T20:50:37.000Z

What's the status of this issue?
As a side note improvement, when using Generate PHPDoc for function or Update PHPDoc comment it could also take care of {@inheritDoc} and use it if it's possible.

Answer 3 · 2019-04-02T20:59:42.000Z

@GarryOne there is a "replace docblock with inheritDoc" alt-Enter action if the inheritDoc is missing.

Answer 4 · 2019-04-02T21:05:33.000Z

@thanosp I don't see this option on PHPStorm 2018.3.5 and PHP inheritDoc helper v1.5.1
The only option related to this is Add inheritDoc when there is no DocBlocks at all. Otherwise, there's no option regarding this.

Answer 5 · 2019-04-02T21:07:39.000Z

@GarryOne indeed when there's no doc you'd see add inheritDoc and replace docblock with inheritDoc when it already has one without inheritDoc.

Answer 6 · 2019-04-02T21:11:47.000Z

@thanosp could you, please, post here a screenshot showing the context when replace docblock with inheritDoc is displayed? Thank you.

I found it, finally, but it shows up only if your cursor is on the function name. I expected to see it also when the cursor is on the DocBlock or on the function parameters.
Or, when I type /** and then press Enter to generate the DocBlock.