gpt4 book ai didi

javascript - JSDoc 记录导出对象中的重复属性

转载 作者:行者123 更新时间:2023-11-28 03:53:48 25 4
gpt4 key购买 nike

我有几个模块,它们的行为方式都相同,并在对象内部导出多个函数,如下所示:

module.exports = {
a:function(paramA,paramB) {
return 1;
},
b:function(paramC,paramD) {
return 'a';
}
}

它们都遵循相同的模式(获取这些参数,执行操作并返回此类型)。我希望能够将所有这些文件记录在同一个文件中,这样文档就不会到处重复。我遇到的问题是,如果我创建一个指定了这些函数的 @typedef ,那么它会被忽略,如果这样做的话:

/**
* @typedef {Object} myModuleType
* @property {functionType} a
*/
/**
* @module A
* @type {myModuleType}
*/
module.exports = {}

如果我创建一个接口(interface),它会提示这些方法没有实现,如果这样做的话:

/**
* @interface myModuleType
*/
/**
* @function
* @name myModuleType#a
* @param paramA
* @param paramB
* @return {number}
*/
/**
* @module A
* @implements {myModuleType}
*/
module.exports = {}

关于如何让它发挥作用有什么想法吗?

最佳答案

因此,原始的 @type 注释实际上有效,只是在记录后不会像 WebStorm 中应有的那样自动完成。

此信息正在 YouTrack 进行跟踪WebStorm 何时修复。

编辑:截至 2017 年 12 月 18 日,该问题已在 WebStorm 的最新版本中修复,并且应该很快就会发布到主分支。

关于javascript - JSDoc 记录导出对象中的重复属性,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/47745352/

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