tsdoc
tsdoc copied to clipboard
eslint-plugin-tsdoc: suggest a rule to check misused function comment
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 => {
...
}