如何描述“对象” jsdoc中的参数？
//我的函数执行X和Y. // @params {object}参数包含参数的对象 // @params {function}回调回调函数 函数（参数，回调）{ } 但是如何描述参数对象应该如何构造？例如，它应该是这样的： { setting1：123，//（必需，整数） setting2：'asdf'//（可选，字符串） } 解决方案 从
..
jsdoc相关内容
在JSDoc中记录开放式参数函数的正确方法
假设你有以下内容： var someFunc = function（）{ // do带参数的东西 } 你怎么能正确记录这个函数可以接受任何数字JSDoc中的参数？这是我最好的猜测，但我不确定它是否正确。 / ** * @param {混合} [...]无限量的可选参数 * / var someFunc = function（）{ //在这里用参数
..
如何使用JSDoc注释核心Node.js模块以在IntelliJ中进行代码提示？
到目前为止，我需要其中两个， util 和 fs 。给出这样的代码： var fs = require（'fs'）; var contents = fs.readFileSync（'path / to / file'，'utf8'）; 不仅IntelliJ标记 readFileSync as 未解决的功能或方法，但在我看来，我也缺乏IDE提供的最佳功能 - 代码提示
..
枚举为JSDoc中的@param类型
是否可以在JSDoc @param 类型声明中使用枚举，如下例所示？ / ** * @enum {Number} * / var TYPES = { TYPE_A：1， TYPE_B ：2 } / ** * @param {TYPES}输入 * / 函数useTypesEnum（type）{ } 如果我使用像Eclipse等IDE这样
..
如何在Google Apps jsdoc说明中强制换行
我无法弄清楚Google Apps脚本如何正确显示。我需要它在jsdoc输出中显示新行（例如，当函数工具提示窗口出现在Spreadheet函数中时）。我已经尝试过像html这样的html，但它只是呈现为文本而不是换行符。 例如： / ** *将前缀值指定的基地。 *需要以下其中一个前缀： *'0b'基数2：二进制 *'0q'基数4：四元 *'0o'基数8：八进制 *'
..
编写关于类内部方法的jsdoc文档
我正在使用Google Apps Script编写一些图书馆，并试图记录它们。我已经用下面的格式编写了一些类，并且类中的方法的注释并未显示在文档中： / ** * My comments here * / function MyBeautifulObject（）{ this.myMethod = myMethod; .... / ** *此评论不会显示
..
如何在Google Doc脚本中预览jsdoc注释
我知道1731号问题已经提出，要求在Google脚本编辑器中预览jsdoc。 http://code.google.com/p / google-apps-script-issues / issues / detail？id = 1731 当我们等待它被实现时，预览的最佳方式是什么jsdoc评论说我添加到我发布的库中，而不需要我创建新版本？现在由Google Apps脚本编辑器的自动完成支持
..
在谷歌应用脚本库中创建一个名称空间组织
我正在研究使用谷歌应用脚本构建工具集。这个问题是，据我所知，只允许一级组织。您可以创建一个名为Stopwatch的库，并调用方法Stopwatch.start（）和Stopwatch.stop（），这非常酷。 我想到的是更多像Utils.Stopwatch（）。start（）和Utils.Timer.start（）等等。我认为这当然可以在JavaScript中使用，但为了不断破坏Apps
..
你用什么函数调用一个对象
你用什么函数调用一个对象。我记录了一些使用jsdoc返回的函数，我无法坚持使用这种方式。 这就是我要返回的 > {fnName：[function]} 或 {fnNameA：[function]，fnNameB：[function]} 我的问题以这种方式记录返回值是表达不会将期望属性当作文字 object.fnName 和作为变量函数名称。
..
javascript - JsDoc有何很实际的具体作用?
问 题 实际现象 欲了解JSDoc所带来的作用 比如这个文件: https://github.com/showdownjs... 预期现象 我自己想到的: 让 js 的接口, 变得静态 (其实主要是 3 ) 方便生成文档 方便 IDE , 同时也是方便调用接口的开发者 那么还会有哪些实际的好处? 解决方案 不管你写不写 JSDoc，
..
如何使用JSDOC3来记录枚举常量
我们正在使用JSDOC来记录我们面向客户端的SDK，我们很难认识到我们的“枚举”（即常量）。我们应该使用哪些标签来让JSDOC在文档中提取？以下是一个示例： / ** * @module枚举 * / 导出命名空间{ / ** * @enum WidgetType {string} * / Enum.WidgetType = { / **仪表板* / 仪表板：“
..
使用显示模块模式时，如何查看eclipse中的轮廓？
我正在重构一些我们拥有的Javascript代码，其中包括改变它以利用显示的模块模式。代码看起来很整洁，它的工作正常，但在大纲视图中我看不到功能。我看到顶级命名空间var为var，但是您无法扩展它以查看其中的函数。 让我们说代码看起来像这样： p> function myFunc1（）{} function myFunc2（）{} / pre> 在这种情况下，您将
..
JsDoc工具包和命名空间 - 警告尝试..没有
我正在使用 jsdoc-toolkit 与命名空间库。代码看起来像这样 namespace.module（'a.b'，//这是命名空间 // @param {Object}在此命名空间中导出可见类 // @param {function}需要其他命名空间 函数（exports，require）{ var entityBase = require（“a.base”）; va
..
使用自定义继承系统记录复杂的JavaScript对象
我正在尝试将现有的服务器端JavaScript API从其现有的手动复制和粘贴继承系统迁移到更好更可靠的系统。纯原型不能使用，因为对象的状态（变量）也必须被继承，并且不能在父对象中覆盖。 所以我正在考虑使用来自John Reisig的好解决方案在这里描述： http://ejohn.org/blog/ simple-javascript-inheritance / 这个工作对我来说非
..
如何JsDoc多重继承或混合？
如何记录mixins或多重继承？ / ** * @class父 * / function Parent（）{ } Parent.prototype.parentTest = 5; / ** * @class Mixin * / 函数Mixin（）{ } Mixin.prototype .mixinTest = 5; / ** * @c
..
如何记录用ngdoc返回一个有角度的类的工厂？
给出一个带有工厂的角度应用程序返回一个类，如下所示： angular.module（'fooApp'） .factory（'User'，function（）{ function User（name）{ this.name = name; } User.prototype.greet = function（）{ return“Howdy”，+ this.name; }
..
JSDoc'ing写在“显示模块模式”中的Javascript文件的最佳实践样式？
我的大部分Javascript函数都比较简单，并且对它们的sideeffect有所帮助：我使用jQuery来操纵DOM或进行Ajax调用。我更喜欢在“透露模块模式”中写我的功能。 我刚刚发现 JSDoc-注释的Javascript文件有一个好处：帮助的注释，Eclipse的JS开发工具可以解析我的JS文件， 填写Eclipse Outline视图（否则为空）。 现在我不知道什么是精细点
..
为什么jQuery不使用JSDoc？
或者他们和它们不在源头？我真的希望得到一些可以阻止js-doc-toolkit在每次解析jQuery时发现的东西。这也意味着我无法使用jQuery作为依赖关系来正确地记录任何代码，而不至少放置一些不正确地记录jQuery结构的样板js-doc块。有没有一个常见的解决方案我不知道？我试过googling，btw。 解决方案 我会在黑暗中拍摄，因为我不能说为什么我的jQuery团队不会使用JS
..
如何在JSDoc中指定解决方案和拒绝类型的承诺？
我有一些代码返回承诺对象，例如使用NodeJS的 Q 库。 var Q = require（'q'）; / ** * @returns ??? * / 函数任务（err）{ return err？ Q.reject（new Error（'Some error'）））：Q.resolve（'Some result'）; } 如何使用JSDoc记录这样的
..
如何使用JSDoc3来编写嵌套的命名空间
我无法使用JSDoc3来记录以这些方式结构化的代码 / ** * @namespace MyNamespace.MySubNamespace * / （function（MyNamespace）{ MyNamespace.MySubNamespace.Foo = { doSomething：function（someParam）{ //做它 } } }）（windo
..