JSDocs - 如何记录隐含参数，并返回

Question

我想知道如何文档的功能如下所示：

var createInput = function() { 
    var type = this.type; 

    this.input = { 
    val: {}, 
    type: type 
    }; 
} 

技术上this.type的输入参数和this.input是什么，是从该对象返回。如何记录这一点？

Answer 1

最好重写一遍代码，这样它就可以获取参数并返回一些没有任何副作用的值。易于记录！

的问题应该是更像如何避免副作用，而不是如何记录副作用。

var createInput = function (type) { 
    return { 
    val: {}, 
    type: type 
    }; 
} 

this.input = createInput(this.type); 

Answer 2

sapithpocker在第二个链接上跳过似乎显示出一个潜在的解决方案。

/** 
* The context of the current class. 
* @typedef {Object} ClassContext. 
* @property {string} type - Indicates type. */ 

/** 
* A method for doing something. 
* @param {...ClassContext} this - a {@link ClassContext} object. 
*/ 
function createInput() { /* Code */ } 

这是说明文件，对于每个使用对象“拥有”的当前上下文，即this方法可以重复使用，并且遵循DRY-原理，以及。