Support parsing TSDoc string comments

Hi there! I am using String Literal types to define classnames and would love to populate with some more information.

So basically:

type TClassnames = 
   /** Some docs about red-500 */
    | 'bg-color-red-500'
   /** Some docs about red-600 */
    | 'bg-color-red-600'

I would love to populate the docs on the right side of the intellisense:

This is how we can document with properties:

Which would be amazing to have on string literals.

I thought it was a TSDoc issue, but given this context: microsoft/tsdoc#164, it seems to be VSCode not parsing it?

This feature is powered by the TypeScript project. Please file an issue upstream so that they can take a look

Navigation Menu