Google 表格自定义函数支持多少 JsDoc?
What amount of JsDoc is supported in Google Sheets custom functions?
Google表示支持JsDoc:
Custom functions will appear in this list if their script includes a
JsDoc @customfunction tag, as in the DOUBLE() example below.
https://developers.google.com/apps-script/guides/sheets/functions
但 JsDoc 似乎并没有得到完全支持,我找不到显示支持和不支持的文档。
我特别在寻找一种方法来记录自定义函数的参数是可选的。像这样,对于 value2:
使用 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 张中对此进行了测试,并且 none 有效。甚至没有建议的 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 记录可选参数的方法,并从屏幕截图中获得所需的结果(这比我目前不优雅的解决方案更好),则加分。
表格自定义函数似乎不支持 JsDoc 可选参数功能,但找不到这方面的官方文档。
我建议您在 this component 中提交功能请求以请求此功能,或者至少更详细地记录支持的功能。
更新:
OP 在问题跟踪器中提交了关于此的功能请求:
任何想要跟踪此内容的人都可以单击参考页面左上角的星标。
Google表示支持JsDoc:
Custom functions will appear in this list if their script includes a JsDoc @customfunction tag, as in the DOUBLE() example below.
https://developers.google.com/apps-script/guides/sheets/functions
但 JsDoc 似乎并没有得到完全支持,我找不到显示支持和不支持的文档。
我特别在寻找一种方法来记录自定义函数的参数是可选的。像这样,对于 value2:
使用 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 张中对此进行了测试,并且 none 有效。甚至没有建议的 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 记录可选参数的方法,并从屏幕截图中获得所需的结果(这比我目前不优雅的解决方案更好),则加分。
表格自定义函数似乎不支持 JsDoc 可选参数功能,但找不到这方面的官方文档。
我建议您在 this component 中提交功能请求以请求此功能,或者至少更详细地记录支持的功能。
更新:
OP 在问题跟踪器中提交了关于此的功能请求:
任何想要跟踪此内容的人都可以单击参考页面左上角的星标。