Google Apps脚本自动生成的库文档

Question

我目前正在开发一个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));
}

现在，对于两个公共函数，生成的文档仅显示返回类型，而不显示参数和附加的说明。我假设这是一个谷歌问题，并没有真正困扰。

但我的主要问题是，由于函数是从私有函数实例化对象，我如何获取自动文档来显示该对象上存在的方法。 所有功能都将由对象提供，如果GAS可以在其上显示方法，那将是很好的。

请注意

---

这些方法都放在函数的原型上。 例如

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

感谢。

Answer 1

Google Apps脚本中支持库的jsdoc变体不支持您要查找的级别的文档，只支持第一级功能。此处有relevant open bug report，但Google没有回复。

您仍然可以编写jsdoc标记，并在Google基础结构之外生成文档。请查看How to preview jsdoc comments in google doc scripts，了解有关如何预览jsdoc注释的一些指示。您可以获取jsdoc3的输出并将其发布到网站上，以便向您的社区提供您的文档。

其他相关/可能重复的帖子：

• Creating a namespace-like organization in a google apps script library
• Writing jsdoc documentation on methods inside a class

Answer 2

如果您正在使用TypeScript，我们已经构建了一个旨在为此提供帮助的软件包：

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

您可以使用它为TypeScript上编写的面向对象的库和客户端API生成自动完成功能。