Google Apps脚本中的多形态功能文档

Question

我希望我的库函数以两种方式工作，具体取决于是否提供了第二个参数。
例如：

function sheet_to_dict(a, b) { 
    var array = (
    b ? SpreadsheetApp.openById(a).getSheetByName(b) : a 
).getDataRange().getValues(); 

现在我应该怎么记录它，使其看起来像：

本文不涉及这个问题：http://googleappsdeveloper.blogspot.de/2012/05/introducing-versions-and-libraries-in.html

Answer 1

您已经只有一小部分jsdoc标签可以在Apps-script中使用，这就是无法复制您在服务文档中看到的结果的一个示例。 Here's a list of reported issues with the support of jsdoc in apps-script。

您可以在应用程序脚本中完成的唯一一件事就是在您的评论中提供有关可选参数的详细文档。不幸的是，这完全无助于自动补全。

下面是一个基于How to preview jsdoc comments in google doc scripts的示例，它使用html表来模拟@param标记的输出，并记录方法的两种变体。截图来自库文档URL https://script.google.com/macros/library/d/<Library-Id>/<ver>。

/** 
* 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[] 
}