In JSDoc 3.1 and later, you can use the new @callback tag to describe the callback function in a separate comment block. You can then refer to the callback in the docs for your method. Here’s an example: /** @class */ function MyClass() {} /** * Do something. * @param {MyClass~onSuccess} cb – Called on … Read more
Move the JSDoc for someProperty into the constructor where it is first defined: /** * SomeClass is an example class for my question. * @class * @constructor * @public */ class SomeClass { constructor () { /** * someProperty is an example property that is set to `true` * @type {boolean} * @public */ this.someProperty … Read more
You can define types in a module (eg. typedefs.js). The module contains your JSDoc typedefs and can simply export an unused property. // typedefs.js /** * @typedef foo * @property {string} bar */ // etc. exports.unused = {}; // or export {}; To use it, import the module where you need to reference these typedefs: … Read more
There are two proper ways of dealing with line breaks in JSDoc. The first, apparently used by Google, is to indent the lines after the first: /** * @param {string} author – The author of the book, presumably some * person who writes well and does so for a living. This is * especially important … Read more