【问题标题】:What amount of JsDoc is supported in Google Sheets custom functions?Google 表格自定义函数支持多少 JsDoc?
【发布时间】:2020-08-25 22:17:54
【问题描述】:

Google 暗示支持 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 记录可选参数的方法,该方法可以从屏幕截图中获得所需的结果(这比我目前不雅的解决方案要好),那么奖励积分。

【问题讨论】:

  • 旁注:您所说的奖励积分是指赏金吗?
  • @TheMaster 是的。 :-)

标签: google-apps-script google-sheets jsdoc custom-function


【解决方案1】:

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

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

更新:

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

任何想要对此进行跟踪的人都可以单击引用页面左上角的星号。

【讨论】:

  • 感谢您的建议。不太熟悉在那里提交问题请求,但现在我确实提交了这个:issuetracker.google.com/issues/156230902
  • @Magne 感谢您报告此事。我使用您引用的链接更新了我的答案,以便有相同问题的人可以轻松找到。
猜你喜欢
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2021-09-19
  • 1970-01-01
  • 2019-10-10
  • 1970-01-01
  • 2022-12-14
相关资源
最近更新 更多