Suggestion

🔍 Search Terms

typescript alias jsdoc to variable assignment

✅ Viability Checklist

My suggestion meets these guidelines:

• This wouldn't be a breaking change in existing TypeScript/JavaScript code
• This wouldn't change the runtime behavior of existing JavaScript code
• This could be implemented without emitting different JS based on the types of the expressions
• This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, new syntax sugar for JS, etc.)
• This feature would agree with the rest of TypeScript's Design Goals.

⭐ Suggestion

Please copy JSDoc data to aliased variables.

📃 Motivating Example

/** Call this in order to something. */
const foo = (s: string): number => 123

const f = foo

f // hovering on 'f' does not show the documentation description "Call this in order to something."

playground

💻 Use Cases

Make documentation easier. All projects need good documentation!

Workaround:

an author can copy/paste duplicate JSDoc comments. This is harder to maintain.