TypeScript JSDoc member documentation not returned by quickInfo

b1payxdu  于 6个月前  发布在  TypeScript
关注(0)|答案(1)|浏览(74)

TypeScript 版本: 2.8.0-dev.20180302
搜索词:
代码

对于 js:

/**
* @param o has a string and a number
* @param o.s the string
* @param o.n the number
*/
function f(o: {s: string; n: number }) { return o.s.length + o.n; }

f({s: 'abc', n: 2})

悬停在 s 上以触发快速信息请求

预期行为:

返回 s 的文档。

实际行为:

没有返回文档:

[Trace  - 6:45:58 PM] Response received: quickinfo (38). Request took 10 ms. Success: true 
Result: {
    "kind": "property",
    "kindModifiers": "",
    "start": {
        "line": 8,
        "offset": 4
    },
    "end": {
        "line": 8,
        "offset": 5
    },
    "displayString": "(property) s: string",
    "documentation": "",
    "tags": []
}

实验链接:
相关问题:

a1o7rhls

a1o7rhls1#

两个问题:

  • 除非你写 @param {object} o,否则我们不会将以下 @param 标签视为成员 - 我们应该在没有 {object} 的情况下支持它们。
  • 我们无法正确获取它们的文档注解。

相关问题