jsdoc

问题 I ask this mostly from a Angular perspective (but any advice would help). I have JSDoc's on my functions but it makes the code look very messy. I would just like to know if there is a way to move the JSDoc's to some type of external file. An example of my JSDoc's: /** * Does a GET call on the service MyGetCall * @param {string} pUserID - 1st Parameter: User Login ID * @param {string} pPassword - 2nd Parameter: User Password * @returns The Call's Http Observable (subscribe to this function). *

问题 I ask this mostly from a Angular perspective (but any advice would help). I have JSDoc's on my functions but it makes the code look very messy. I would just like to know if there is a way to move the JSDoc's to some type of external file. An example of my JSDoc's: /** * Does a GET call on the service MyGetCall * @param {string} pUserID - 1st Parameter: User Login ID * @param {string} pPassword - 2nd Parameter: User Password * @returns The Call's Http Observable (subscribe to this function). *

问题 I have something like this: let { total } = settings; How do I document the total variable? I tried something like this: /** * @type {Object} * @property {String} total.test */ let { total } = settings; but it doesn't seem to be the right way. Any suggestions? 回答1: @Tommy-Pepsi Gaudreau was so close in his comment on the original question. Here's an example in the closure compiler tool @ closure-compiler.appspot.com let /** @type {Object<string|boolean>} */ settings = {}; let str = 'string';

问题 I'm currently building a webshop with node.js and I wanted to include a documentation of pretty much all of my commented javascript code. I can easilly create a documentation with JSDoc and create a pretty html documentation, but that's not what I want to have. I want to create a navigation in my website where the documentation is integrated in my spa. So I have done some research and found some npm modules like jsdoc-x which creates JSON based of the JSDoc comments, but it is rather cryptic

问题 I have an HTML file. There are some JSDoc inside like this: /** * If true, this slider is disabled. A disabled slider cannot be tapped * or dragged to change the slider value. * * @attribute disabled * @type boolean * @default false */ I need to get info and put into a bean class MyBean { public String comment; public String attribute; public String type; public String defaultValue; } How do I parse my HTML file? 回答1: There are several JSDoc parsers out there. Take a look into doctrine and

问题 I'm writing Javascript with Visual Studio Code on a Mac. I have this function, documented in JSDoc format: /** * Adds the passed Matter Body to the simulation. * @param {Matter.Body} body - The body to add to the physics simulation * @param {string} imageUrl - The URL of the image to use to represent this body in the simulation. It should match an image URL that has already been added via loadImages() * @param {function} [onCollide] - Optional function to call when this body collides */

问题 I'm trying to write documentation for a Module function like this: /** * Usage: * * ``` * @NgModule({ * imports: [ * BrowserModule, * ..., * ThisModule.forRoot({ * name: 'Name', * version: '1.0', * ], * }), * ``` * * @param config Service configuration parameters */ public static forRoot(config: SVConfig) { The problem is with @NgModule . I've tried with: * ``` * @NgModule Seems that html entitites works well outside code (```), but not inside code block (it does something weird like making

问题 I'm trying to write documentation for a Module function like this: /** * Usage: * * ``` * @NgModule({ * imports: [ * BrowserModule, * ..., * ThisModule.forRoot({ * name: 'Name', * version: '1.0', * ], * }), * ``` * * @param config Service configuration parameters */ public static forRoot(config: SVConfig) { The problem is with @NgModule . I've tried with: * ``` * @NgModule Seems that html entitites works well outside code (```), but not inside code block (it does something weird like making

问题 I'm trying to write documentation for a Module function like this: /** * Usage: * * ``` * @NgModule({ * imports: [ * BrowserModule, * ..., * ThisModule.forRoot({ * name: 'Name', * version: '1.0', * ], * }), * ``` * * @param config Service configuration parameters */ public static forRoot(config: SVConfig) { The problem is with @NgModule . I've tried with: * ``` * @NgModule Seems that html entitites works well outside code (```), but not inside code block (it does something weird like making

问题 I'm trying to document the input parameters to a function in javascript, but I can't work out how to do it in jsdoc. I've looked at the jsdoc documentation which suggests that using the @callback comment is what's required, but Visual Studio Code (vscode) doesn't highlight it as per the screenshot. The intellisense for the location parameter shows that it's type any rather than of type locator (a function with a parameter of id which returns a Location ). Example code which shows a function