6

私は現在、基本的にスプレッドシートをデータベース オブジェクトとして扱う Google Apps Script のライブラリを開発しています。

現在、ライブラリには次のような2つの同一の機能があります

/**
* 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));
}

現在、2 つのパブリック関数について、生成されたドキュメントには戻り値の型のみが示され、パラメーターや添付された命令は示されていません。これは Google の問題であり、あまり気にしていないと思います。

しかし、私の主な質問はこれです。関数はプライベート関数からオブジェクトをインスタンス化しているため、そのオブジェクトに存在するメソッドを表示する自動ドキュメントを取得するにはどうすればよいですか。すべての機能はオブジェクトによって提供され、GAS がオブジェクトのメソッドを表示できれば素晴らしいことです。

ノート

メソッドはすべて関数のプロトタイプに配置されます。例えば。

SpreadsheetQuery_.prototype.from = 関数 (シート) {
    if (_.isNumeric(シート)) {
        ....
}

ありがとう。

4

2 に答える 2

7

Google Apps Script のライブラリでサポートされている jsdoc バリアントは、探しているレベルのドキュメントをサポートしておらず、第 1 レベルの関数のみをサポートしています。これに関する未解決のバグ レポートがありますが、Google からの回答はありません。

引き続き jsdoc タグを記述し、Google インフラストラクチャの外部でドキュメントを生成できます。jsdocコメントをプレビューする方法については、Google ドキュメント スクリプトで jsdoc コメントをプレビューする方法を参照してください。出力を取得jsdoc3してサイトに公開し、ドキュメントをコミュニティに提供できます。

その他の関連/重複する可能性のある投稿:

于 2013-03-01T15:31:53.777 に答える