VS代码:是否可以在文件中声明JSDoc函数定义,然后在另一个文件中导入/引用它?

时间:2019-01-31 15:27:20

标签: visual-studio-code jsdoc

目标:
通过将所有JSDoc内容移至另一个文件来减少我的javascript文件中的代码行数。我没有问题 自定义类型,仅带有函数。


问题描述:
鉴于此示例VS Code项目文件结构:

project
|
+-- src
|   +-- functions
|   |   +-- functions.js
|   +-- type-definitions
|   |   +-- functions.js

是否可以在文件中专门定义JSDoc 函数类型,以便可以在其他文件中使用它们?


我尝试过的事情
以下是我尝试过的无效示例:

(/ src / 类型定义 /functions.js)

/**
 * @typedef {function} Foo
 * @description This is the 'Foo' function
 * @returns {{foo: String}} A JSON Object.
 * @param {!String} bar (Required).
 */

还...

/**
 * @function Foo
 * @description This is the 'Foo' function
 * @returns {{foo: String}} A JSON Object.
 * @param {!String} bar (Required).
 */

(/ src / 功能 /functions.js)

import '../type-definitions/functions';
export const Foo = bar => ({ foo: 'bar' });

所需结果
,当鼠标悬停在 / src / functions /functions.js 中的Foo函数上时:

以上内容目前适用于自定义类型,但不适用于函数。

0 个答案:

没有答案