search

microsoft / tsdoc

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

Deprecate and remove @override #322

Closed Gerrit0 closed 1 month ago

Gerrit0 commented 2 years ago

TypeScript 4.3 introduced the override keyword, which appears to have the same semantics as this tag, with the benefit of being directly recognized by the language. As such, for recent TS versions this tag is potential for confusion. It should either be deprecated / removed, or it's documentation updated to clarify why it exists alongside the keyword and when it should be used instead/in addition to the keyword.

zelliott commented 2 years ago

The override keyword isn't present in the .d.ts (https://github.com/microsoft/TypeScript/issues/2000#issuecomment-813527475) and API Extractor runs on .d.ts. Playground. This should be mentioned in the documentation at https://tsdoc.org/pages/tags/override/. Thoughts @octogonz?

SmashingQuasar commented 1 year ago

I second @Gerrit0's issue regarding this tag. It should be deprecated. However, is TSDoc handling the native override keyword?