Google Apps脚本自动生成的库文档

我目前正在为Google Apps脚本开发一个库，该库基本上将电子表格作为数据库对象处理。Google Apps脚本自动生成的库文档

目前，库有两个相同的功能，如

 
/** 
* Opens and creates a query object for a spreadsheet with the given url. 
* 
* @param {String} the url of the spreadsheet 
* @return {SpreadsheetQuery_} a spreadsheet query object for the given spreadsheet 
*/ 
function openByUrl(url) { 
    return new SpreadsheetQuery_(SpreadsheetApp.openByUrl(url)); 
}

现在，对于两个公共的功能，只有所产生的文档显示的返回类型，而不是参数也不附说明书。我认为这是一个谷歌问题，并没有真正困扰。

但我的主要问题是，因为函数是从私有函数实例化一个对象，我如何获取自动文档以显示该对象上存在的方法。所有的功能都将由对象提供，如果GAS能够显示对象的方法，那将是非常好的。

注意

的方法都放置在函数的原型。例如。

 
SpreadsheetQuery_.prototype.from = function (sheet) { 
    if (_.isNumeric(sheet)) { 
     .... 
}

谢谢。

来源

2013-03-01 frostymarvelous

在Google Apps脚本中为图书馆提供支持的jsdoc变体不支持您正在查找的文档，只有第一级功能。这里有一个relevant open bug report，但没有回应谷歌。

您仍然可以编写您的jsdoc标签，并在Google基础结构之外生成文档。看看How to preview jsdoc comments in google doc scripts了解如何预览您的jsdoc评论。您可以输出jsdoc3并将其发布到网站上以向您的社区提供您的文档。

其他有关/可能重复的帖子：

来源

2013-03-01 15:31:53 Mogsdad

我猜着了。我记录了整个文件，谷歌仍然没有拿起它。我希望他们在不久的将来支持这一点。无论如何，我将使用您的方法并在单独的文件上生成文档。谢谢。 – frostymarvelous 2013-03-02 09:43:02

Google Apps脚本自动生成的库文档

回答

相关问题