【问题标题】:how to add method description for visual studio code?如何为 Visual Studio 代码添加方法描述?
【发布时间】:2020-08-06 18:05:13
【问题描述】:

在某些方法上,Visual Studio Code (VSC) 会自动描述智能感知建议,如下所示:

如何为自定义代码完成此操作,我尝试查找此名称接口的源代码: 并找到了这段代码:

    /** Returns a string representation of a function. */
toString(): string;

所以我尝试在我的类方法中添加相同的内容:

      /** Returns a string representation of a function. */
nowUTS()
      {

        return Math.round(Date.now()/1000);
      }

但是当 VSC 给出这个方法作为建议时,我只是在视觉上得到这个:

我应该如何记录我的 Visual Studio 代码 intellisense 的类方法以获取描述?

【问题讨论】:

    标签: typescript visual-studio-code intellisense


    【解决方案1】:
    【解决方案2】:

    您应该将文档注释放在函数nowUTS() 上方。参考检查 JSDoc 文档:https://jsdoc.app/about-getting-started.html

    【讨论】:

    • 是的!刚刚编辑了我的问题以给出另一个示例并找到了这个,总是当我问解决方案弹出时......谢谢
    猜你喜欢
    • 2019-08-02
    • 2011-03-14
    • 2013-03-09
    • 2018-01-12
    • 2019-08-12
    • 1970-01-01
    • 2019-11-20
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多