jsdoc

可以将文章内容翻译成中文,广告屏蔽插件可能会导致该功能失效(如失效，请关闭广告屏蔽插件后再试): 问题: I know that Issue 1731 has been raised requesting preview of jsdoc within the Google script editor. http://code.google.com/p/google-apps-script-issues/issues/detail?id=1731 While we wait for that to be implemented, what's the best way to preview jsdoc comments that I'm adding to my published library, without requiring me to create a new version? 回答1: Update 2014: With libraries now supported by the Google Apps Script editor's autocompletion, it's possible to get immediate feedback about SOME of your library's jsdoc comments. This solution

可以将文章内容翻译成中文,广告屏蔽插件可能会导致该功能失效(如失效，请关闭广告屏蔽插件后再试): 问题: I want to disable multicolored JSDoc comments in Visual Studio Code. Currently, the JSDoc comments look like this ('@param', etc. is colored something other than the default comment color): JSDoc Highlighted Comment I want the entire comment to be the same default grey color. I tried disabling all extensions and custom user settings, but that didn't affect the JSDoc highlighting. Does anyone know what settings I need to change to fix this? I thought either workbench.colorCustomizations or editor.tokenColorCustomizations would have the

Can I define all custom types in a separate file (e.g. types.jsdoc ), so that they can be reused throughout the application? What's the right way to do it? /** * 2d coordinates. * @typedef {Object} Coordinates * @property {Number} x - Coordinate x. * @property {Number} y - Coordinate y. */ I just tried with VSCode and it works only if the separate file is opened in the editor. If not, external typedefs are typed as any You can define types in a module (eg. typedefs.js ). The module contains your JSDoc typdefs and can simply export an unused property. // typedefs.js /** * @typdef foo *

Or do they and it's just not in the source? I'd really like to get something that will stop js-doc-toolkit from freaking out each time it parses jQuery. It also means I can't properly document any code using jQuery as a dependency without at least putting some boilerplate js-doc blocks, which fail to properly document jQuery's structure. Is there a common solution I'm not aware of? I have tried googling, btw. Nick Craver I'll take a shot in the dark here since I can't speak for the jQuery team of why I wouldn't use JSDoc. JSDoc, at least the last time I checked, didn't have any clean way to

I have 2 types of Modules: Require.js Main File : require.config({ baseUrl: "/another/path", paths: { "some": "some/v1.0" }, waitSeconds: 15, locale: "fr-fr" }); require( ["some/module", "my/module", "a.js", "b.js"], function(someModule, myModule) { } ); Mediator Pattern: define([], function(Mediator){ var channels = {}; if (!Mediator) Mediator = {}; Mediator.subscribe = function (channel, subscription) { if (!channels[channel]) channels[channel] = []; channels[channel].push(subscription); }; Mediator.publish = function (channel) { if (!channels[channel]) return; var args = [].slice.call

I have some code that returns a promise object, e.g. using Q library for NodeJS. var Q = require('q'); /** * @returns ??? */ function task(err) { return err? Q.reject(new Error('Some error')) : Q.resolve('Some result'); } How to document such a return value using JSDoc? Even if they don't exist in Javascript, I found that JSdoc understands "generic types". So you can define your custom types and then use /* @return Promise<MyType> */ . The following result in a nice TokenConsume(token) → {Promise.<Token>} with a link to your custom Token type in the doc. /** * @typedef Token * @property {bool}

According to the JSDoc wiki for @param you can indicate a @param is optional using /** @param {String} [name] */ function getPerson(name) { } and you can indicate a param inline using function getPerson(/**String*/ name) { } And I can combine them like the following, which works ok. /** @param [name] */ function getPerson(/**String*/name) { } But I would like to know if there is a way to do it all inline if possible. From official documentation : Optional parameter An optional parameter named foo. @param {number} [foo] // or: @param {number=} foo An optional parameter foo with default value 1.

I'd like to document (in the Google Sheet autocomplete) a custom function with optional arguments, similar to the WEEKDAY function (autocomplete below). The JSDoc spec on optional arguments does not work. Google does not seem to document this anywhere. How can I create a function with the same visual treatment (both in the argument description and the Example) that Google has? /** * Summary of function * @param {"example"} arg Argument description * @param {"optional"} opt_arg This argument is optional * @return {String} Return value description * @customfunction */ function JSDOC(arg, opt_arg