microsoft / microsoft/TypeScript

Formatting Intellisense For Better JS/TS Doc Integration

Open
#60,300 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Experience Enhancement Suggestion
Dominant language
Go
Stars
111k
Forks
14.4k
Avg merge
1d 19h
Merged PRs (30d)
117

Description

Does anyone know if it is possible to modify VSCode Intellisense for JSDoc and TSDoc tags? I have always been bothered by the way VSCode handles certain JS/TS doc tags and I just cannot handle it anymore.

As trivial as it might sound, when documenting custom interface and type definitions, I just want the @property tag to be formatted in the same manner as the @param tag. The following screen shots illustrate my issue:

Image

Notice the emdash between the @property tags and the keys being described above?

Image

See how it's placed after the @param tags and the respective keys?

If this feature cannot be implemented, does anyone know of any extensions that already do this or which files need to be modified to make this change?

Any advice would be much appreciated. Cheers 🍻

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No source file or test is identified. Start by tracing how VSCode and TypeScript IntelliSense format JSDoc and TSDoc @property and @param tags, then determine whether the change belongs in TypeScript or an extension. Done means the relevant tags display with consistent key formatting, backed by an appropriate test or documented extension limitation.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, typescript, vscode
Domain
developer-experience, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.