相关疑难解决方法(0)

如何在JSDoc中指定对象数组作为参数或返回值?

在JSDoc中,如果您有一个特定类型的数组(例如字符串数组),我可以找到的最佳文档显示使用以下内容:

/**
 * @param {Array.<string>} myStrings All my awesome strings
 */
 function blah(myStrings){
     //stuff here...
 }
Run Code Online (Sandbox Code Playgroud)

你如何替换下面的问号指定一个对象数组?

/**
 * @param {???????} myObjects All of my equally awesome objects
 */
 function blah(myObjects){
     //stuff here...
 }
Run Code Online (Sandbox Code Playgroud)

javascript documentation jsdoc

87
推荐指数
1
解决办法
5万
查看次数

如何在JSDoc中将对象数组作为参数进行记录?

我有一个看起来像这样的数组:

[{
    "name": "c917379",
    "email": "jim@bmw.de"

},
{
    "name": "c917389",
    "email": "jane@bmw.de"
}]
Run Code Online (Sandbox Code Playgroud)

它是一个任意长度的数组,带有许多重复的字段(为了清楚起见,我将其缩减为两个字段).这会传递给JavaScript方法.

/**
 * @param {?}  data
 */
update:  function(data) {...}
Run Code Online (Sandbox Code Playgroud)

我想知道你将如何在JSDoc中记录这个.IE浏览器.你如何记录问号所在的类型?

javascript jsdoc

12
推荐指数
3
解决办法
5989
查看次数

如何在JSDOC中记录对象数组

我有一个带有一个对象数组作为参数的函数,并希望使用JSDOC来描述参数(包括数组中对象的属性),如下例所示:

/**
 * @param {Array.<Object>} filter - array of filter objects
 * @param ...
 */
function doSomething(filter) {
}
Run Code Online (Sandbox Code Playgroud)

过滤器是这样的:

filter = [
   {id: 'session', value: 1},
   {id: 'name', value: 'john'}
]
Run Code Online (Sandbox Code Playgroud)

如何将文件的属性id,并value在jsdoc3?

javascript jsdoc jsdoc3

9
推荐指数
1
解决办法
5144
查看次数

描述JsDoc中的对象数组

我有一个带有一系列对象的函数.
看起来像这样.

myAwesomeFunction([
    {
        name: 'someName',
        next: false,
        test: 'test'
    },
    {
        name: 'nameTwo',
        next: true
    }
]);
Run Code Online (Sandbox Code Playgroud)

到目前为止,我的JSDOC看起来像这样

/**
 * My description
 * @param {Array.<Object>}
 */
Run Code Online (Sandbox Code Playgroud)

但是,如何描述对象属性,类型和描述以及它们是否是对象的可选项?

谢谢.

javascript jsdoc jsdoc3

5
推荐指数
2
解决办法
2502
查看次数

标签 统计

javascript ×4

jsdoc ×4

jsdoc3 ×2

documentation ×1