Как добавить описание метода для кода Visual Studio? - PullRequest
1 голос
/ 23 апреля 2020

В некоторых методах Visual Studio Code (VS C) автоматически описывает предложения по intellisense, например:

enter image description here

Как это можно сделать для пользовательского кода я попытался выяснить в источнике для этого интерфейса имени: и нашел этот фрагмент кода:

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

Поэтому я попытался добавить то же самое в мой метод класса:

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

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

Но когда VS C дает этот метод в качестве рекомендации, я получаю это только визуально:

enter image description here

Как мне документировать мои методы класса для Visual Studio Код IntelliSense, чтобы подобрать описание?

Ответы [ 2 ]

1 голос
/ 23 апреля 2020

Вам необходимо установить jsdoc добавить

enter image description here

Ссылка для скачивания https://marketplace.visualstudio.com/items?itemName=stevencl.addDocComments

Подробнее при https://code.visualstudio.com/Docs/languages/javascript#_jsdoc -поддержка

1 голос
/ 23 апреля 2020

Вы должны разместить комментарий к документации над функцией nowUTS(). Для справки JSDo c документация: https://jsdoc.app/about-getting-started.html

...