TypeScript 悬停@param comments 复制悬停中的注解 翻译结果:悬停@param comments 复制悬停中的注解

pnwntuvh  于 4个月前  发布在  TypeScript
关注(0)|答案(3)|浏览(36)

测试 microsoft/vscode#223154

ukqbszuj

ukqbszuj1#

最小仓库:

/**
* @param x Does the thing
*/
function foo(x) {}

@param x 中悬停在 x 上后显示重复的 tags 部分的示例响应:

Perf 621  [14:55:38.646] 204::quickinfo: elapsed time (in milliseconds) 5.1846
Info 622  [14:55:38.646] response:
    {"seq":0,"type":"response","command":"quickinfo","request_seq":204,"success":true,"body":{"kind":"parameter","kindModifiers":"","start":{"line":3,"offset":11},"end":{"line":3,"offset":12},"displayString":"(parameter) x: any","documentation":[{"text":"Does the thing","kind":"text"}],"tags":[{"name":"param","text":[{"text":"x","kind":"parameterName"},{"text":" ","kind":"space"},{"text":"Does the thing","kind":"text"}]}]}}
voj3qocg

voj3qocg2#

重复的标签
@mjbvz 看起来没有重复的标签,但是 param 标签有重复的评论,这些评论都包含在 documentationtags 的信息中。是否应该将与参数标签相关的评论仅限于标签中?
/cc @sandersn

oxiaedzo

oxiaedzo3#

是的,我可以更清楚地表达:整个 tags 部分应该被省略,因为我们已经在悬停在特定的标签上。相反,我们应该只返回 documentation 中的标签内容,并将 tags 留空。

相关问题