如何为VS Code可以识别的包装函数编写TSDocs?

时间:2019-05-20 19:30:52

标签: typescript visual-studio-code documentation

我一直在写很多包装函数,如下所示:

Max(IIf([CURRENT_FLAG]=1 And [QUALIFICATION_ID] In (14800000086) And [CMC_POS_CODE_TRANSLATOR] In (1,3,6,8,12,13,15,18,20,25,32,90,91,92,94,96,98,100,102,103,230),[ISSUED_ON],IIf([CMC_POS_CODE_TRANSLATOR] Not In (1,3,6,8,12,13,15,18,20,25,32,90,91,92,94,96,98,100,102,103,230),"","0")))

/** * Adds two numbers * @param the first number * @param the second number */ const add = wrapped((a:number, b:number) => a + b); 处,一些函数接受一个函数并返回具有相同签名的函数,例如:

wrapped

但是,当我在Visual Studio Code中的某个地方使用此功能时,VS Code似乎不像通常那样了解该功能的文档:

Missing documentation hints

如果我改为使用内部函数的文档编写function wrapped<F extends (...args: any[]) => any>(f:F): F { // ...whatever... return f; } 函数,如下所示:

add

我获得了有关期望参数的文档: Correct documentation hints

但是现在,当我尝试自动完成功能时,缺少文档:

More missing documentation hints

我是否可以通过某种方式编写此函数,这样我就可以在两个地方都获得文档提示,而不仅仅是将其复制/粘贴并包含在内部函数和外部函数中?

0 个答案:

没有答案