Microsoft/TypeScript

JSDoc support for destructured parameters

Open

#11.859 geöffnet am 26. Okt. 2016

Auf GitHub ansehen
 (12 Kommentare) (44 Reaktionen) (0 zugewiesene Personen)TypeScript (6.726 Forks)batch import
Domain: JSDocHelp WantedIn DiscussionSuggestionVS Code Tracked

Repository-Metriken

Stars
 (48.455 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 6T 17h) (9 gemergte PRs in 30 T)

Beschreibung

TypeScript Version: 2.0.3

Code

interface Foo {
    /**
     * A bar value
     */
    bar?: string;
}

/**
 * A function
 *
 * @param foo A param
 * @param { bar } Another param
 * @param bar Another param
 */
function foo(foo: string, { bar }: Foo): void {
    bar;
    foo;
}

foo('bar', { bar: 'play' });

Expected behavior:

Intellisense for the second argument, or the second argument properties.

Actual behavior:

No way of providing a description for the destructured elements of a destructured parameter.

destructured

Contributor Guide