首页 > 解决方案 > Google 表格自定义函数支持多少 JsDoc?

问题描述

谷歌暗示支持 JsDoc:

如果自定义函数的脚本包含 JsDoc @customfunction 标记,则自定义函数将出现在此列表中,如下面的 DOUBLE() 示例所示。

https://developers.google.com/apps-script/guides/sheets/functions

但似乎没有完全支持 JsDoc,而且我找不到显示支持和不支持的文档。

我特别在寻找一种方法来记录自定义函数的参数是可选的。像这样,对于 value2:

在此处输入图像描述

图片提供:https ://yagisanatode.com/2018/08/24/google-apps-script-how-to-make-a-custom-function-to-use-in-google-sheets/

使用 JsDoc,您应该能够根据以下来源执行以下操作: https ://jsdoc.app/tags-param.html#optional-parameters-and-default-values

/**
 * @param {number} [value2] - Additional numbers or ranges to add to value1.
 */

并且,使用默认值:

/**
 * @param {number} [value2=100] - Additional numbers or ranges to add to value1.
 */

但是我在 Google 表格中对此进行了测试,但这些都不起作用。甚至没有建议的 Google Closure Compiler 语法(以防万一):

/**
 * @param {number=} value2 - Additional numbers or ranges to add to value1.
 */

目前,我采用了不太优雅的方式:

/**
 * @param {number} value2 - [OPTIONAL] Additional numbers or ranges to add to value1.
 */

那么,我在哪里可以找到有关 Google 表格支持 JsDoc 的哪些部分的文档?

如果您可以展示一种使用 JsDoc 记录可选参数的方法,该方法可以从屏幕截图中获得所需的结果(这比我当前的不优雅的解决方案更好),那么奖励积分。

标签: google-apps-scriptgoogle-sheetsjsdoccustom-function

解决方案


Sheets 自定义函数似乎不支持 JsDoc 可选参数功能,但找不到官方文档。

我建议您在此组件中提交功能请求以请求此功能,或者至少更详细地记录支持的功能。

更新:

OP 在问题跟踪器中提交了关于此的功能请求:

任何想要跟踪这一点的人都可以单击引用页面左上角的星号。


推荐阅读