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

Question

3

有些方法，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 Code Intellisense可以获取描述？

- Vincent Duprez

2个回答

3

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

- Max Amorim

是的！刚刚编辑了我的问题，给出了另一个例子，然后就找到了这个答案，每次我问问题时解决方案总是冒出来..谢谢 - undefined

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- Hien Nguyen · Accepted Answer

您应该安装jsdoc插件。