jsdoc

I'm still learning js and trying out the Webstorm IDE, which seems sweet (including jumping to var/function declarations). I can see how to get the template for a jsdoc comment to appear but I'm not experienced with it and looking for an example of how to provide more detail in the comment and how to view that detail. WebStorm 4.0 supports most of JSDoc tags. For example, when you specify @type for variable, completion will work better and assignments of expressions with wrong types will be highlighted as warnings. Element documentation popup appears when Ctrl+Q is pressed on some reference.

How do I doc a variable number of parameters? I am writing an application in PHP and JavaScript. Currently I have (in JavaScript): /** * Description * @param {String} description */ function fn() { // arguments holds all strings. } So, how do I doc n-number of string params? E.g. PhpDocumentor suggests using an ellipsis /** * Example of unlimited parameters. * Returns a formatted var_dump for debugging purposes * (since the recurrences of $v are not listed in the actual function signature in the code, * you may wish to highlight they are "optional" in their description) * @param string $s

We're using JSDOC to document our client-facing SDK and we're having difficult getting it to recognize our 'enums' (i.e. constants). Which tags should we use to get JSDOC to pick it up in the documentation? Here's a sample: /** * @module Enum */ export namespace { /** * @enum WidgetType {string} */ Enum.WidgetType = { /** Dashboard */ Dashboard: 'dashboard', /** Form */ Form: 'entityeditform', /** Report */ Report: 'report' }; } Here's how the 'enums' are used in code: app.widget({ id: 'account_entityform', type: Enum.WidgetType.Form }).add(); How can we document this with JSDOC? ASA2 After

I have something like this: /** Diese Klasse bla bla... @constructor **/ my.namespace.ClassA = function(type) { /** This function does something **/ this.doSomething = function(param){ } } The class will get listed in the generated documentation. The function won't. Is there a way to tell JSDoc (3) that this is a member function of the class ClassA ? JSDoc needs some additional information to recognize the function as member function: /** * Diese Klasse bla bla... * @constructor */ my.namespace.ClassA = function(type) { /** * This function does something * @function * @memberOf my.namespace

I have a JavaScript singleton defined as: /** * A description here * @class */ com.mydomain.ClassName = (function(){ /** * @constructor * @lends com.mydomain.ClassName */ var ClassName = function(){}; /** * method description * @public * @lends com.mydomain.ClassName */ ClassName.prototype.method1 = function(){}; return new ClassName(); })(); No warnings are printed in verbose mode (-v), but the documentation reports only "com.mydomain.ClassName()" with "A description here" as description... how can I generate documentation for ClassName's methods too? I solved! :) /** * A description here *

Is there a way to fold JSDoc-style comment blocks in VSCode v1.25 for JavaScript files? I get normal code collapse offered, but comment blocks seem excluded. Is there a keyboard shortcut that would collapse code even without the GUI handlebars showing? locofierro I had the same issue, and fixed it by doing this: Go to File -> Preferences -> Settings and change the following entry from auto to indentation "editor.foldingStrategy": "indentation" Now JSDoc comments are folding as expected, hope this works for you as well! { "key": "ctrl+k ctrl+/", "command": "editor.foldAllBlockComments", "when":

WebStorm does a very good job of resolving functions which are returned from CommonJS modules as methods (and reads JsDoc associated with them), like for instance: // utils/valid.js /** * Returns true no matter what. * @param {HTMLElement} element * @return {boolean} */ function isValid(element) { return true; } module.exports.isValid = isValid; // exports property Such a function is then correctly provided in code completion and inline documentation mechanisms when such a module is required in another file. // main.js var isValid = require('./utils/isValid').isValid; // works well However,

I want to specify a type in one file, and be able to reuse it in another one. I tried modules but it didn't work in VS Code. Is there any other solution? Just wanna have all types for my project to be reusable so I can reference them in different functions across files. This is the closest question I have found. I've had some success with using jsconfig.json and its include property in a plain JavaScript project in Visual Studio Code 1.33.1 { "include": [ "src/**/*.js" ] } Given the following JavaScript project: src/ ├── types/ | ├── person.js | ├── question.js | ├── answer.js ├── jsconfig