7

問題1731が発生し、Googleスクリプトエディタ内でjsdocのプレビューを要求していることを知っています。http://code.google.com/p/google-apps-script-issues/issues/detail?id=1731

それが実装されるのを待つ間、新しいバージョンを作成する必要なしに、公開されたライブラリに追加しているjsdocコメントをプレビューするための最良の方法は何ですか？

4

1 に答える 1

6

2014年の更新：ライブラリがGoogle Apps Scriptエディターのオートコンプリートでサポートされるようになったため、ライブラリのjsdocコメントの一部についてすぐにフィードバックを得ることができます。

このソリューションは理想的ではありません-公開されたGoogleスクリプトライブラリと同じ外観を提供しません-しかし、少なくとも私はjsdocコメントを調べて、新しいバージョンを絶えず作成することなく、それらがどのように見えるかについての良いアイデアを得ることができます機能拡張のないライブラリ。誰かが公開から表示される正確な出力を取得するための追加の手順を詳しく説明できる場合は、共有してください。

これは私がWindows7PCで行ったことです。同様の手順が他のプラットフォーム、ymmvでも機能する可能性があります。

  • リポジトリをzipファイルとしてダウンロードしてjsdoc3を入手します。

  • 便利な場所に解凍します。使用しC:\jsdocました。これにより、jsdoc3に必要なRhinojvmもインストールされます。

次に、Googleスクリプトをjsdoc3で解析できるローカルファイルに取り込む必要があります。繰り返しますが、誰かがより良い方法を知っているなら、私はすべての耳です！

  • GoogleScriptProjectのローカルディレクトリを設定します。C:\myscript、 いう。

  • google docs / drive / anyのスクリプトに移動し、すべてをシステムクリップボードにコピーします。

    <ctrl-A> <ctrl-C>

  • お気に入りのテキストエディタを使用して、クリップボードの内容を貼り付けます

    <ctrl-V>

  • 結果をjavascriptファイルに保存します。C:\myscript\testing.js、 いう。

了解しました。ここからは、ファイルを解析し、出力を監査し、満足するまでjsdocコメントを編集します。

jsdoc3の出力は「out」ディレクトリに送られます。

  • でコマンドウィンドウを開きますC:\myscript。

  • javascriptファイルを解析します。

    \jsdoc\jsdoc testing.js

  • デフォルトのブラウザで出力を開きます。

    out\index.html

  • 希望する結果が得られるまで、すすぎ、繰り返します。

  • 編集したスクリプトをコピーしてGoogleスペースに貼り付け、コードが壊れていないことを確認し、新しいバージョンを作成して、公開されたライブラリのドキュメントを生成します。

警告：

  • 出力の形式は、公開されているGoogle Script Libaryに表示されるものとは異なりますが、内容はほとんど同じです。Googleではjsdocタグのサブセットのみがサポートされていることに注意してください（@paramおよび@returnsのみ）。他のタグをコードに含めることはできますが、それらは無視されます。

  • HTMLテーブルをjsdocコメントに含めることができますが、カスタマイズオプションは限られています。

    • <tbody></tbody>すべての行をタグで囲む必要があります。内の行<thead>は無視されます。
    • さらに-すべて<th>無視されます。最初の行を目立たせるには、<b></b>タグを使用します。
    • セルの書式設定などを気にしないでくださいalign。無視されます。
    • スタイル属性内で幅を指定でき、それは存続します。

例：

jsdocとgooglescriptdocの両方でレンダリングされるいくつかの要素の例を次に示します。

/**
 * Demonstrate jsdoc with a table. Otherwise, meaningless gibberish.
 *
 * <table> 
 * <tbody>
 * <tr><td style="width: 75%"><b>Student Name</b></td><td style="width: 25%"><b>Idiocy Factor</b></td></tr>
 * <tr><td> John Smith      </td><td align=right>  18 </td></tr>
 * <tr><td> Sally Doe       </td><td align=right>  53 </td></tr>
 * <tr><td> Carmen Sandiego </td><td align=right>  90 </td></tr>
 * <tr><td> Tam O'Shanter   </td><td align=right> 180 </td></tr>
 * </tbody>
 * </table>
 *
 * Continuation of function description down here. Why not have an example?
 * <pre>
 * =myFunc($A8, $DV8 )
 * </pre>
 *
 * @param {String} your mother's name, e.g. <code>"Anne Murray"</code>
 * @param {String} date of birth, <code>DD/MM/YYYY</code>
 * @returns {Date} estimated date of demise
 * @returns {String} "Please try again." if error in input
 */

完璧ではなく、かなり高いPITA値があります。それでも、jsdocは、サポートされていないタグの構文を正しく取得し、移植性に優れていることを確認します。

于 2012-09-20T15:42:20.250 に答える