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腳本自動生成的庫文檔

回答

相關問題