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.json Where both question.js and person.js are type definitions: person.js … Read more
If you’re looking for how to document the type of objects in an array, you want something like this: /** * @param {String[]} aliases */ Here inside curly-braces the String[] is the parameter type: type String as array []. See also jsdoc-toolkit, archived wiki page about @Param tag, Parameter Type Information: Parameter Type Information Use … Read more
I would rate jsduck from Sencha on top. I have used it on many projects. Simple to use https://github.com/senchalabs/jsduck A single command will generate docs like this http://docs.sencha.com/touch/2-0/
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
Figured it out. The following inserts a relative reference to the document js/index.html: `Javascript API <js/index.html>`_
Late answer, but since I came across this googling something else I thought I’d have a crack at it. You’ve probably found by now that the JSDoc site has decent explanations and examples on how to document ES6 features. Given that, here’s how I would document your example: /** * module description * @module MyClass … Read more
Finally, I found a tool that solves this problem: JSDoc.app JSDoc 3 is an API documentation generator for JavaScript, similar to Javadoc or phpDocumentor. You add documentation comments directly to your source code, right alongside the code itself. The JSDoc tool will scan your source code and generate an HTML documentation website for you. After … Read more
Just put the doc comment before each property: export interface ISource { /** * Bias: bias_text[rating.bias[0]], */ b: string /** * Domain: `rating.domain.replace(/^www\./, “”)` */ d: string … } (Also, don’t use type annotations in JSDocs inside TS files; the compiler and tooling will ignore these types)
I found the way to do it: /** * @param {*} foo */ function bar(foo) {}
From jsdoc.app for the @type annotation: A type expression can include the JSDoc namepath to a symbol (for example, myNamespace.MyClass); a built-in JavaScript type (for example, string); or a combination of these. You can use any Google Closure Compiler type expression, as well as several other formats that are specific to JSDoc. […] Each type … Read more