Написание jsdoc документации по методам внутри класса

Question

Я пишу некоторые библиотеки в Google Apps Script и пытаюсь их документировать. Я написал несколько классов в следующем формате, и комментарии к методам внутри класса не отображаются в документации:

/**
* My comments here
*/
function MyBeautifulObject(){

   this.myMethod=myMethod;
   ....

   /**
   * This comment doesn't show up
   */

   function myMethod(){
     ...
   }

}

Есть идеи, как мне этого добиться?

Answer 1

Этот вопрос может быть дубликатом... этот ответ, безусловно, есть.

Вариант jsdoc, поддерживаемый для библиотек в Google Apps Script, не поддерживает документацию на уровне, который вы ищете, только функции первого уровня. Существует соответствующий открытый отчет об ошибке, но нет ответа от Google.

Вы по-прежнему можете писать свои теги jsdoc и создавать свою документацию вне инфраструктуры Google. Посмотрите, как просмотреть комментарии jsdoc в сценариях google doc, чтобы узнать, как просмотреть комментарии jsdoc. Вы могли бы взять вывод jsdoc3 и опубликовать его на сайте, чтобы предоставить свои документы для вашего сообщества.

Другие соответствующие / возможные повторяющиеся сообщения:

• Создание организации, подобной пространству имен, в библиотеке скриптов приложений Google
• Документация по автоматически генерируемой библиотеке скриптов Google Apps

Answer 2

Если вы работаете с TypeScript, мы создали пакет, который поможет в этом:

https://github.com/maelcaldas/clasp-types

Мы используем его для генерации автозаполнения для наших объектно-ориентированных библиотек и клиентского API, написанного на Typescript.