Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TSDoc tag excluded from IntelliSense #77261

Closed
bookmoons opened this issue Jul 12, 2019 · 1 comment
Closed

TSDoc tag excluded from IntelliSense #77261

bookmoons opened this issue Jul 12, 2019 · 1 comment
Assignees
Labels
*as-designed Described behavior is as designed feature-request Request for new features or functionality javascript JavaScript support issues

Comments

@bookmoons
Copy link

bookmoons commented Jul 12, 2019

A TSDoc tag excluded from the IntelliSense display would be useful. If type declarations are used to generate the full API docs, there may be some things (eg very lengthy descriptions or examples) you want in the docs but not cluttering the small IntelliSense box.

I think it's nice to have @remarks in IntelliSense as a midsize extended description.

VSCode right now lists all tags, including unrecognized custom tags. So it seems to be impossible to get docs-only tags even if you defined custom tags.

/**
 * @notATag Custom tag not in standard TSDoc.
 */
export function foo(): void;

foo-cropped

Possible tags @extended @extendedExample:

/**
 * Take over the specified world.
 * 
 * @param world - The world to dominate.
 * 
 * @remarks
 * Optimizes for minimum loss of life, minimum reputation harm, and maximum deviousness.
 * Leverages all available capital and human resources without remorse.
 *
 * @extended
 * The development of this procedure began with the Sumerian kings.
 * [... long history ...]
 * 
 * @extendedExample
 * // Example of error handling based on the latest best practices
 * while (!retired) {
 *   try { takeOverWorld(earth) } catch (error) {
 *     if (error instanceof InsurrectionError) squashInsurrection()
 *     else if (error instanceof CoupError) decimateCoup()
 *     else if (error instanceof GlobalThermonuclearWarError) retire()
 *     [.. long example list .. ]
 *   }
 * }
 * 
 * @beta
 */
export function takeOverWorld(world: World): void;
@mjbvz
Copy link
Collaborator

mjbvz commented Jul 12, 2019

Displaying custom tags was a feature request. We show them after the important bits of intellisense that we do parse (such as types and top level descriptions) I don't think it is worth adding a setting to hide them as it's just additional information, some of which may be useful

@mjbvz mjbvz closed this as completed Jul 12, 2019
@mjbvz mjbvz added the *as-designed Described behavior is as designed label Jul 12, 2019
@vscodebot vscodebot bot locked and limited conversation to collaborators Aug 26, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
*as-designed Described behavior is as designed feature-request Request for new features or functionality javascript JavaScript support issues
Projects
None yet
Development

No branches or pull requests

2 participants