6

我目前正在为 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)) {
        ……
}

谢谢。

4

2 回答 2

7

Google Apps 脚本中的库支持的 jsdoc 变体不支持您要查找的级别的文档，仅支持一级函数。有一个相关的开放错误报告，但谷歌没有回应。

您仍然可以编写 jsdoc 标签，并在 Google 基础架构之外生成文档。查看如何在 google doc 脚本中预览 jsdoc 评论，以获取有关如何预览 jsdoc 评论的一些指导。您可以获取输出jsdoc3并将其发布在站点上，以将您的文档提供给您的社区。

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

于 2013-03-01T15:31:53.777 回答
2

如果你正在使用 TypeScript，我们已经构建了一个包来帮助解决这个问题：

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

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

于 2019-09-16T10:18:31.077 回答