how to add method description for visual studio code?

Question

On some methods, Visual Studio Code ( VSC ) automatically describes the intellisense suggestions like this :

How can this be done for custom code, I tried finding out on the source for this name interface: and found this piece of code :

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

So I tried adding the same to my class method:

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

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

But when VSC gives this method as a suggestion, I only get this visually:

How should I document my class methods for visual studio code intellisense to pick up the description ?

Hien Nguyen · Answer 1 · 2020-04-23T12:19:08.233

4

You should install jsdoc add in

edited Apr 23 '20 at 12:19

answered Apr 23 '20 at 12:11

Hien Nguyen

score 2 · Accepted Answer · answered Apr 23 '20 at 12:10

2

You should place the documentation comment above the function nowUTS(). For reference check JSDoc documentation: https://jsdoc.app/about-getting-started.html

answered Apr 23 '20 at 12:10

Max Amorim

Yes! Just edited my question to give another example and found this one out, always when I asking that the solutions pops out.. thank you – Vincent Duprez Apr 23 '20 at 12:17

2 Answers2