Microsoft/TypeScript

Support @class in JSDoc

Open

#12.681 geöffnet am 5. Dez. 2016

Auf GitHub ansehen
 (2 Kommentare) (11 Reaktionen) (0 zugewiesene Personen)TypeScript (6.726 Forks)batch import
Domain: JSDocDomain: JavaScriptHas ReproHelp WantedSuggestionVS Code Tracked

Repository-Metriken

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

Beschreibung

From https://github.com/Microsoft/vscode/issues/15168

For the following JavaScript code:

/**
 * @class
 * 
 * @param {number} x
 */
function Foo(x) {
    this.x = x
}

/**
 * @param {Foo} foo
 */
const request = function(foo) {

}

The @class jsdoc annotation for Foo does not seem to be recognized, so the type of foo in request is any:

screen shot 2016-12-05 at 3 25 07 pm

Changing the code to use class fixes the issue (you don't actually need the @class in this case):

screen shot 2016-12-05 at 3 26 45 pm

Contributor Guide