gpt4 book ai didi

JSDoc 继承参数文档

转载 作者:行者123 更新时间:2023-12-04 08:43:19 27 4
gpt4 key购买 nike

假设我有两个功能,其中一个扩展了另一个。

/**
* @abstract
* @param {Object} settings
* @param {Number} settings.x
* @param {Number} settings.y
*
*/
function Base(settings) {
this.x = settings.x;
this.y = settings.y;
}

/**
* @extends Base
*/
function Foo(settings) {
Base.call(this, settings);
}

这两个函数位于两个单独的文件中。有什么方法可以从我的 Base 函数中的 Foo 函数继承参数文档,还是必须编写两次文档?

我试过像这样使 settings 成为 @typedef:
/**
* @typedef {Object} BaseSettings
* @property {Number} x
* @property {Number} y
*
*/

/**
* @extends Base
* @param {BaseSettings} settings
*/
function Foo(settings) {
Base.call(this, settings);
}

但这只是链接到全局类型定义,我希望参数记录在与函数相同的页面上。但这甚至可能吗,无需编写两次文档?

最佳答案

我不认为这是可以做到的。您可以按照您的问题通过 @typedef 记录它,但它只会将类型链接到其定义。我不知道内联定义类型的方法。

关于JSDoc 继承参数文档,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/29521446/

27 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com