如何为 Visual Studio 代码添加方法描述？

Question

在某些方法中，Visual Studio Code ( 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 给出这个方法作为建议时，我只能从视觉上得到这个：

我应该如何记录 Visual Studio 代码智能感知的 class 方法以获取描述？

Answer 1

你应该安装jsdoc add in

Answer 2

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