在应用脚本中，如何在自定义函数中包含可选参数

In Apps Script, How to include optional arguments in custom functions

本文关键字：包含可 参数 自定义函数 应用 脚本      更新时间：2023-09-26

我想编写一个自定义函数，它有一些强制性参数，但也可以接受一些可选参数。我找不到任何关于此的文档。有人知道吗？它类似于Javascript吗？

自定义函数没有必填字段和可选字段的概念，但您可以使用如下逻辑模拟该行为：

function foo(arg1, opt_arg2) {
  if (arg1 == null) {
    throw 'arg1 required';
  }
  return 'foo';
}

约定使用前缀"opt_"作为可选参数，但这不是必需的。

是的，它是JavaScript（对JsDoc的支持也有限），所以你可以有一个带有默认值的可选参数：

/**
 * This is myFunction.
 * @param {number} arg1 - Some number.
 * @param {string} arg2 - Some string.
 * @param {number} arg3 - [OPTIONAL] Additional numbers or ranges to add to value1.
 * @customFunction
**/
function myFunction(arg1, arg2, arg3=false) {
  return arg3;
}

然后，您可以使用以下任一方法在电子表格中调用它：

=myFunction(1, "somestring", true)

或者没有可选参数：

=myFunction(1, "somestring")

由于JavaScript动态处理参数列表。

相关文章：