Skip to content

Provide snippet completions for @param in JSDoc #52370

Closed
@DanielRosenwasser

Description

@DanielRosenwasser
/**
 * @para$
 */
function printValue(value, maximumFractionDigits) {
}

Today, we provide the expected @param JSDoc tag completion.

However, if we're going by the book with JSDoc, the name of the parameter is already known. Can we provide snippet completions that contain the name of the parameter?

Thoughts:

  1. This should work in both JS and TS.
  2. In TS it should have a placeholder by the comment
  3. In JS it should have a placeholder that starts on the type, followed by a placeholder at the comment
  4. I don't know (/remember) how this should work with destructuring.

Metadata

Metadata

Assignees

Labels

Domain: Completion ListsThe issue relates to showing completion lists in an editorDomain: JSDocRelates to JSDoc parsing and type generationEffort: ModerateRequires experience with the TypeScript codebase, but feasible. Harder than "Effort: Casual".Fix AvailableA PR has been opened for this issueHelp WantedYou can do thisSuggestionAn idea for TypeScript

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions