I do the following in my code. /** Express router providing user related routes * @module routers/users * @requires express */ /** * express module * @const */ const express = require(‘express’); /** * Express router to mount user related functions on. * @type {object} * @const * @namespace usersRouter */ const router = express.Router(); … Read more
I have encountered this issue as well. I am now writing documentation for angularjs codes through jsdoc comments like this: 1.Make a blank .js file with the following comment: /** * @namespace angular_module */ This will create a separate html in the generated documentation for listing all modules. 2.In javascript files that defines any new … Read more
I usually use something like the code below in my projects. function example() { /** * Need to explain the purpose of X here. * @type {number} */ var X = 100; … /** * Need to explain the purpose of Y here. * @type {string} */ var Y = ‘abc’; … return Z; }
You can use a combination of @module or @namespace along with @memberof. define([], function() { /** * A test module foo * @version 1.0 * @exports mystuff/foo * @namespace foo */ var foo = { /** * A method in first level, just for test * @memberof foo * @method testFirstLvl */ testFirstLvl: function(msg) {}, … Read more
This seems to be working for me. /** * @param {Number} count – number of times to prompt * @return {function(): void} – the returned function */ manyPrompts(count) { /** * My inner function * * @param {object} prompt Some parameter */ const inner = function(prompt) { for (let i=0; i < count; i++) { … Read more
You can achieve that, by doing this: /** * @param {(1|2)} type */ function useTypesEnum(type) { }
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
Define your structure separately using a @typdef: /** * @typedef {Object} Point * @property {number} x – The X Coordinate * @property {number} y – The Y Coordinate */ And use it as the return type: /** * Returns a coordinate from a given mouse or touch event * @param {TouchEvent|MouseEvent|jQuery.Event} e * A valid … Read more