Even if they don’t exist in Javascript, I found that JSdoc understands “generic types”. So you can define your custom types and then use /* @return Promise<MyType> */. The following result in a nice TokenConsume(token) → {Promise.<Token>} with a link to your custom Token type in the doc. /** * @typedef Token * @property {bool} … Read more
JSDoc 3 has a @callback tag for exactly this purpose. Here’s a usage example: /** * Callback for adding two numbers. * * @callback addStuffCallback * @param {int} sum – An integer. */ /** * Add two numbers together, then pass the results to a callback function. * * @param {int} x – An integer. … Read more
The JSDoc specs and Google’s Closure Compiler do it this way: @param {…number} var_args Where “number” is the type of arguments expected. The complete usage of this, then, would look like the following: /** * @param {…*} var_args */ function lookMaImVariadic(var_args) { // Utilize the `arguments` object here, not `var_args`. } Note the comment about … Read more
According to the JSDoc 3 docs: Arrays and objects (type applications and record types) An object with string keys and number values: {Object.<string, number>} So it would be: /** @type {{locales: Object.<string, {name: string, lang: string}>}} */ var CONF = { locales: { en: { name: “English”, lang: “en-US” }, es: { name: “Spanish”, lang: … Read more
Closure Compiler According to the documentation of Google’s Closure Compiler if nothing is being returned, the @return annotation should be omitted. If there is no return value, do not use a @return tag. Source: https://developers.google.com/closure/compiler/docs/js-for-compiler#tags jsdoc-toolkit However further documentation also states that the returnType and returnDescription are optional parameters. returnType – Optional: the type of … Read more
Visual Studio 1.10 is now able to generate JSDoc comments. Just type /** above the function See Also: VS Code Docs > Languages > Javascript > JSDoc Support VS Code February 2017 Release Notes > Auto JSDoc Comments
This is how it’s intended, as described in the documentation. /** * My cool function. * * @param {Object} obj – An object. * @param {string} obj.prop1 – Property 1. * @param {string} obj.prop2 – Property 2. */ const fn = function ({prop1, prop2}) { // Do something with prop1 and prop2 } So, your … Read more
As of late 2014 in jsdoc3 you have the possibility to write: /** * @param {(‘rect’|’circle’|’ellipse’)} shapeType – The allowed type of the shape */ Shape.prototype.getType = function (shapeType) { return this.type; }; Of course this will not be as reusable as a dedicated enum but in many cases a dummy enum is an overkill … Read more
From official documentation: Optional parameter An optional parameter named foo. @param {number} [foo] // or: @param {number=} foo An optional parameter foo with default value 1. @param {number} [foo=1]
You should be more specific what you mean by JSDoc – this is a generic term covering pretty much all the JavaDoc-style documentation tools for JavaScript. The syntax you used for array of strings looks like the one supported by Google Closure Compiler. Using this, an array of Objects would be: /** * @param {Array.<Object>} … Read more