Документация по автоматически генерируемой библиотеке скриптов Google Apps

В настоящее время я занимаюсь разработкой библиотеки для скрипта Google Apps, которая в основном рассматривает электронную таблицу как объект базы данных.

В настоящее время библиотека имеет две одинаковые функции, такие как

/**
* Opens and creates a query object for a spreadsheet with the given url.
*
* @param {String} the url of the spreadsheet
* @return {SpreadsheetQuery_} a spreadsheet query object for the given spreadsheet
*/
function openByUrl(url) {
    return new SpreadsheetQuery_(SpreadsheetApp.openByUrl(url));
}

теперь для двух открытых функций сгенерированная документация показывает только тип возвращаемого значения, а не параметр и не прилагаемые инструкции. Я предполагаю, что это проблема Google и не очень беспокоит.

Но мой главный вопрос заключается в следующем: поскольку функции создают экземпляр объекта из закрытой функции, как я могу получить автоматическую документацию для отображения методов, существующих на этом объекте. Все функциональные возможности будут предоставлены объектом, и было бы здорово, если бы GAS мог показать методы на нем.

НОТА

Все методы размещены на прототипе функции. например.

SpreadsheetQuery_.prototype.from = function (sheet) {
    if (_.isNumeric (sheet)) {....
}

Благодарю.

Источник

1 ответ

Решение

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

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

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

Источник

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

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

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

Источник
Другие вопросы по тегам