如何為 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