Document generic type parameters in JSDOC

by

In the meantime, support for this feature has been finalized and is now documented on the Closure Compiler JSDOC page for generics.

Basically it works like this for ES6 classes:

/** @template T */
class Foo {
  /** @return {T} */
  get() { ... };

  /** @param {T} t */
  set(t) { ... };
}

… and like this for pre-ES6 code:

/**
 * @constructor
 * @template T
 */
Foo = function() { ... };

and

/** @return {T} */
Foo.prototype.get = function() { ... };

/** @param {T} t */
Foo.prototype.set = function(t) { ... };

WebStorm 7.0 did not support this feature at the time the original answer was written, but as of today (2019) all JetBrains IDEs understand this syntax, properly.

More Related Contents:

  1. How to describe “object” arguments in jsdoc?
  2. How to import js-modules into TypeScript file?
  3. How to debug angular protractor tests in WebStorm
  4. Correct way to document open-ended argument functions in JSDoc
  5. How do I use WebStorm for Chrome Extension Development?
  6. How to fight tons of unresolved variables warning in WebStorm?
  7. Path aliases for imports in WebStorm
  8. Why I am not getting warnings about StrictNullChecks in typescript
  9. How can I fix WebStorm warning “Unresolved function or method” for “require” (Firefox Add-on SDK)
  10. Webstorm: “Cannot Resolve Directory”
  11. How can I run nodemon from within WebStorm?
  12. intellisense and code complete for DefinitelyTyped (TypeScript type definitions) on WebStorm IDE
  13. Show results of multiple prompt boxes using Javascript [closed]
  14. Regular Expression jquery validation1 [duplicate]
  15. I would like to ask how to explain this (javascript function)
  16. Parse an HTML string with JS
  17. Can’t append element
  18. CORS – How do ‘preflight’ an httprequest?
  19. What’s the recommended way to extend AngularJS controllers?
  20. Contains case insensitive
  21. Javascript parseInt() with leading zeros
  22. What are the semantics of different RxJS subjects?
  23. What is the best way to detect retina support on a device using JavaScript?
  24. Window.Open POST
  25. How to find an appropriate object in array by one of its properties
  26. Can you alter a Javascript function after declaring it?
  27. Safari not sending cookie even after setting SameSite=None; Secure
  28. Preventing Canvas Clear when Resizing Window
  29. Add multiple window.onload events
  30. Kyle Simpson’s OLOO Pattern vs Prototype Design Pattern

Leave a Comment