問題タブ [jsdoc]

本番環境にプッシュする前に、開発環境でコマンド ラインを使用してすべての js ファイルをテストする必要があります。この 3 をどのように統合すればよいですか? 走れるように

同様に jsdoc を使用して、jsdoc スタイルの API ドキュメントを生成します。

どんなアイデアや提案も高く評価されます。

以下のようなコードで、JSDoc（v2.4.0）を使用してオブジェクトリテラルの各プロパティを説明するドキュメントを生成できることを期待していましたが、機能しませんでした。JSDocを使用して、getter / setterを使用するコードからドキュメントを生成する方法を知っている人はいますか？

以下を使用してこのタイプのクラスを文書化する方法を知りたいのですがjsdoc。

BackboneJS コードを JSDoc で文書化したことがありますか?

次のようなバックボーン構造に注釈を付ける際に問題があります。

アドバイスをいただければ幸いです。ありがとう。

jsdoc を使用して doc ファイルを生成すると、いくつかの警告が発生します

なぜ？

しかし、どのようにパラメーター オブジェクトを構造化する必要があるかを説明するにはどうすればよいでしょうか? たとえば、次のようになります。

例のように、コンストラクターでパラメーターとプロパティの名前が同じである場合、@property と @param に 2 つの別々の行を入力する必要を回避する方法はありますか。

関連：JSDocでオープンエンドの引数関数を文書化する正しい方法

arguments変数にアクセスして複数の配列を受け入れる関数があります。

optionsこれで、他の各引数は、文書化する価値のある値を含む配列であることがわかりました。

（長い）説明を変数パラメーター行に入れることは考えていません。

@param {...}検索語、置換、およびそのオプションを含む配列。インデックス0：関数内の検索語。1：置換テキスト。2：オプションのオプション（catch_errors：エラーをキャッチしてログに記録する、escape：置換テキストのドルをエスケープする、pos：検索語の前に置換を配置する場合は "L"、後に配置する場合は "R"）読み取り可能なソリューションではなく、タイプは表示されません。

変数パラメーターのタイプと値を文書化する方法はありますか？

上記は醜いように見えますが、それは私が達成しようとしていることのアイデアをあなたに与えるはずです：

• 変数パラメーター（この場合は配列）のタイプを文書化します
• この配列の値を文書化します
• この配列内のオブジェクトのプロパティを文書化する

怠惰のために、私はオブジェクトの代わりに配列を使用しました。他の提案はいつでも歓迎です。

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

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

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

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