tsdoc icon indicating copy to clipboard operation
tsdoc copied to clipboard

`@inheritdoc` does not work in Visual Studio Code (only `@inheritDoc` does)

Open Josmithr opened this issue 4 years ago • 4 comments

VSCode intellisense does not seem to respect all lower-case @inheritdoc in tsdoc comments. It seems to only respect the camelCase @inheritDoc. Other tools (e.g. API-Extractor) do not seem to have any issue with the all lower-case form.

Note that the eslint plugin also does not seem to care about casing. If the all lower-case form is not considered valid per spec, then it would be nice if the eslint plugin would catch the incorrect casing.

That the linter and the VSCode behavior seem to disagree on casing requirements makes it very easy to introduce comments that are incompatible with VSCode intellisense.

Josmithr avatar Sep 21 '21 17:09 Josmithr

Does @inheritDoc work for you today in vscode? I run into this quite frequently where it doesn't seem that inheritDoc is supported at all by vscode.

connorskees avatar Oct 23 '23 16:10 connorskees

it doesn't work for me

ShravanSunder avatar Dec 10 '23 15:12 ShravanSunder

typedoc does not identify inheritdoc so inheritDoc is the way. Either way a method description with @inheritDoc is not evaluated by vscode. Would be really nice if it did.

image

teshanshanuka avatar Jan 09 '24 10:01 teshanshanuka