tsdoc icon indicating copy to clipboard operation
tsdoc copied to clipboard

eslint-plugin-tsdoc: suggest a rule to check misused function comment

Open trim21 opened this issue 2 years ago • 0 comments

raise a error for this:

bad:

// function comment not recognized by tsc
const getShortName = (name: string): string => {
   ...
}

tsc doesn't think this is a function comment and doesn't emit it in type definition.

good:

/**
 * function comment not recognized by tsc
 */
const getShortName = (name: string): string => {
   ...
}

trim21 avatar Apr 27 '23 11:04 trim21