2

类似于当我记录这样的函数时 ide 如何帮助描述。

/**
 * My Test fn
 * @param a - some description here
 */
function Test(a) {}

我希望 ide 在以下场景中显示描述,但除了“(JSX 属性)测试:布尔值”之外,我无法让它说出任何内容

interface TestProps {
    /** Some comment here */
    test: boolean;
}
class TestComp extends React.Component<TestProps, any> {
    render() {
        return <span>{this.props.test}</span>
    }
}

const test = (props) => (
    <div><TestComp test={true} /></div>
)

在帮助测试属性时,有没有办法让它显示描述?

例子:在此处输入图像描述

在此处输入图像描述

请注意底部图像有 - 一些描述和顶部没有

4

2 回答 2

0

TypeScript 使用 JSDoc。/* Some comment here */不是有效的 JSDoc。/** Some comment here */是正确的方法。

VSCode / TypeScript 中的错误

除了评论错误的事实之外。存在一个错误,无法显示已在 TypeScript / VSCode 中修复的文档。

更多关于 JSDOC

http://usejsdoc.org/about-getting-started.html

于 2017-07-06T19:28:58.537 回答
0

这已在 TypeScript 2.4 和 VSCode 1.14 中得到修复:

在此处输入图像描述

VSCode 1.14 附带 TS 2.4。您可以通过检查 VSCode 状态栏右下角的 TS 版本来确保 TS 2.4 处于活动状态

在此处输入图像描述

您还可以按照这些说明在旧版本的 VSCode 中使用新版本的 TS

如果您遇到任何其他问题,请告诉我们

于 2017-07-06T21:17:50.130 回答