如何为 visual studio 代码添加方法描述？

Question

在某些方法中，Visual Studio 代码 (VSC) 会自动描述这样的智能感知建议：

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

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

所以我尝试将其添加到我的 class 方法中：

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

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

但是当 VSC 给出这个方法作为建议时，我只能从视觉上得到这个：

我应该如何记录我的 class 方法，以便 visual studio 代码智能感知获取描述？

Answer 1

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

Answer 2

你应该安装 jsdoc 添加

how to add method description for visual studio code?