Sort jsdoc parameter suggestions by argument position

TypeScript Version: 2.7.0-dev.20171116

Code

For the code:

/**
 * @param |
 */
function foo(z, a) {}

Trigger completions at the | after @param

Expected behavior:
z is returned first, followed by a. The sortText can be used for this

Actual behavior:
a and z are returned with sort orders weights:

[Trace  - 11:33:07 PM] Sending request: completions (176). Response expected: yes. Current queue length: 0
Arguments: {
    "file": "/Users/matb/projects/san/y.ts",
    "line": 2,
    "offset": 11,
    "includeExternalModuleExports": true
}
[Trace  - 11:33:07 PM] Response received: completions (176). Request took 2 ms. Success: true 
Result: [
    {
        "name": "a",
        "kind": "parameter",
        "kindModifiers": "",
        "sortText": "0"
    },
    {
        "name": "z",
        "kind": "parameter",
        "kindModifiers": "",
        "sortText": "0"
    }
]

PRs welcomed.

Matt Bierner (@mjbvz)

Matt Bierner (@mjbvz) tell me how to reproduce this situation, plz.
Where can I see the trace that is specified in the issue description?
[Trace - 11:33:07 PM] Sending request ***

In your vscode user settings, set "typescript.tsserver.trace": "verbose".
Open output panel and go to the TypeScript section

Is this still an issue? I tried this:

/** */
public test(b: number, a: number) {
    console.log(a);
    console.log(b);
}

with the caret placed after ** auto complete shows a completion of "JSDoc comment", hitting Return produces this, with the caret placed after @param b

/**
 * 
 * @param b 
 * @param a 
 */
public test(b: number, a: number) {
    console.log(a);
    console.log(b);
}

Yes. It is correct when using a template to generate the doc comment. This issue tracks the sort order when you trigger suggestions after @param.

Looking into this issue

Matt Bierner (@mjbvz)

Hi Matt Bierner (@mjbvz), I'm a first-time contributor. Is this issue still relevant to take up?

Matt Bierner (@mjbvz)

Hi Matt Bierner (@mjbvz), Mohamed Hegazy (@mhegazy), Nathan Shively-Sanders (@sandersn), Ryan Cavanaugh (@RyanCavanaugh), This is my first time contributing to an open-source project, and I’m really excited to start! I’ve read the issue and I’m planning to go through the contribution guidelines to make sure I follow the process correctly. I’d like to work on this issue if it’s still relevant.

Before I dive in, I wanted to ask:

Is this issue still a priority, or has it already been resolved in recent updates?
Could you point me to the folder or file where the related logic is implemented, so I can start exploring the codebase?
I’ve already checked the repository and have some ideas about where to start, but any pointers would help me focus my efforts.

Thank you in advance for your guidance, and I’m looking forward to contributing!

@PARAM

Sort JSDoc @PARAM completions by argument position

Checking in to see if this is still open for a PR? I’d like to help out with the requested changes

@PARAM

fix: sort JSDoc @PARAM completions by parameter position (microsoft#2…

Sort JSDoc parameter suggestions by argument position

Stella (@LeonxLJX)

I'd like to take this one (Sort jsdoc parameter suggestions by argument position). I'll look into the root cause and follow up with a PR. (claiming via Stella (@LeonxLJX))

Stella (@LeonxLJX)

I'd like to take this one (Sort jsdoc parameter suggestions by argument position). I'll dig into the root cause and follow up with a PR shortly. (claiming via Stella (@LeonxLJX))

Stella (@LeonxLJX)

I'd like to take this one (Sort jsdoc parameter suggestions by argument position). I'll look into the root cause and follow up with a PR. (claiming via Stella (@LeonxLJX))

Navigation Menu

Repository navigation

Sort jsdoc parameter suggestions by argument position #20183

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Sort jsdoc parameter suggestions by argument position #20183

Description

Activity

mhegazy commented on Nov 21, 2017

bmsdave commented on Dec 26, 2017

mjbvz commented on Jan 2, 2018

SimonGustavsson commented on Oct 10, 2018

mjbvz commented on Oct 11, 2018

shonnungar commented on Oct 1, 2020

ckcherry23 commented on Dec 9, 2023

RafaelMeir4 commented on Jan 19, 2025

ManishPrakkash commented on Mar 16, 2026

LeonxLJX commented on Sep 1, 2026

LeonxLJX commented on Sep 1, 2026

LeonxLJX commented on Sep 1, 2026

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions