search

microsoft / tsdoc

A doc comment standard for TypeScript
https://tsdoc.org/
MIT License
4.7k stars 130 forks source link

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

Open Josmithr opened 2 years ago

Josmithr commented 2 years ago

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.

connorskees commented 10 months ago

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.

ShravanSunder commented 8 months ago

it doesn't work for me

teshanshanuka commented 7 months ago

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