Documentation 谷歌应用程序脚本中的多态函数文档
我希望我的库函数以两种方式工作,具体取决于是否提供了第二个参数。Documentation 谷歌应用程序脚本中的多态函数文档,documentation,google-apps-script,jsdoc,parametric-polymorphism,Documentation,Google Apps Script,Jsdoc,Parametric Polymorphism,我希望我的库函数以两种方式工作,具体取决于是否提供了第二个参数。 例如: function sheet_to_dict(a, b) { var array = ( b ? SpreadsheetApp.openById(a).getSheetByName(b) : a ).getDataRange().getValues(); 现在,我应该如何记录它,使其看起来像: 本文没有讨论这个问题:您在应用程序脚本中使用的jsdoc标记的子集有限,这是一个无法复制服务文档中显示的结果的
例如:
function sheet_to_dict(a, b) {
var array = (
b ? SpreadsheetApp.openById(a).getSheetByName(b) : a
).getDataRange().getValues();
现在,我应该如何记录它,使其看起来像:
本文没有讨论这个问题:您在应用程序脚本中使用的jsdoc标记的子集有限,这是一个无法复制服务文档中显示的结果的示例 在应用程序脚本中,您唯一能做的就是提供有关注释中可选参数的详细文档。不幸的是,这根本无助于自动完成 下面是一个基于的示例,它使用html表模拟
@param
标记的输出,并记录方法的两个变体。屏幕截图来自图书馆文档URL,https://script.google.com/macros/library/d//
/**
*以许多惊人的方式做着不可思议的事情。
*
*
*jsdocTest(var1,var2)
*
*第一种变体的描述。
*
*参数类型描述
*var1数字参数的数字说明
*字符串参数的var2字符串说明
*
*
*
*jsdocTest(var3,var4)
*
*第二种变体的说明。
*
*参数类型描述
*var3对象参数的对象描述
*var4 String[]字符串数组的说明
*
*/
函数jsdocTest(){
//通过参数[]处理所有参数
}
/**
* Does incredible things, in a number of amazing ways.
*
* <pre>
* jsdocTest( var1, var2 )
* </pre>
* Description of the first variant.
* <table><tbody>
* <tr><td style="width: 20%"><b>Parameter</b></td><td style="width: 15%"><b>Type</b></td><td style="width: 65%"><b>Description</b></td></tr>
* <tr><td> var1 </td><td> number </td><td> Description of Number Parameter </td></tr>
* <tr><td> var2 </td><td> string </td><td> Description of String Parameter </td></tr>
* </tbody></table>
*
* <pre>
* jsdocTest( var3, var4 )
* </pre>
* Description of the second variant.
* <table><tbody>
* <tr><td style="width: 20%"><b>Parameter</b></td><td style="width: 15%"><b>Type</b></td><td style="width: 65%"><b>Description</b></td></tr>
* <tr><td> var3 </td><td> Object </td><td> Description of Object parameter </td></tr>
* <tr><td> var4 </td><td> String [] </td><td> Description of String Array </td></tr>
* </tbody></table>
*/
function jsdocTest () {
// Handle all parameters via arguments[]
}