2

私は初めてjsdocを使用していますが、構文が少し気に入らないようで、次のようなものが見つかりません。

(function(){  // issue #1
    /**
     * Creates an instance of a Cube animation
     * @class
     */
    function Cube(x, y, z){
       ...
    }

    /** @lends Cube.prototype */
    cubeFrame.prototype = { // Issue #2
       ...
    }
})();

問題＃1：何らかの理由で、「警告：ドキュメント化されていないシンボルキューブのメンバーとしてsomeMethodをドキュメント化しようとしています」というエラーが発生します。そのラッピング関数をそのままにしておくと、コメントアウトすると機能します。

@lends Cube.prototype問題＃2：クラスで少し奇妙なことをしているので、次のオブジェクトをに適用するのではなく、に適用するという観点から言うと、jsDocに注意を向けさせる方法がわかりCubeませんcubeFrame。＃1とほぼ同じエラーが発生します：「警告：getVoxelをドキュメント化されていないシンボルcubeFrameのメンバーとしてドキュメント化しようとしています。」私はcubeFrame文書化されたくありません、私はそのプロトタイプをCube文書化に入れて欲しいです。

これらの2行を書き直して、ドキュメントを生成することはできますが（その後、無効なコードになります）、変更を加えるたびにドキュメントを生成するためにコードを書き直す必要はありません。

4

1 に答える 1

3

タグを使用し@nameてjsdocにオブジェクトの名前を知らせ、次にクラスの名前を知らせ@lends、オブジェクトリテラルの直前にタグを置き換えます。好き：

(function(){
    /**
     * Creates an instance of a Cube animation
     * @class
     * @name Cube
     */
    function Cube(){
       //...
    }
    cubeFrame.prototype = /** @lends Cube.prototype */{ // Issue #2
       //...
       /**
       */
       someMethod: function(){}
    };
})()
于 2011-06-27T20:13:17.813 に答える