問題タブ [jsdoc3]

jsdoc を使用してマングース モデル メソッドを文書化しようとしています。モデルのメソッドはモデルに属しているため、メンバーメソッドとして表示したいと思います。

このファイルには、トップレベルの@module models行も含まれています。

現在、クラス定義へのリンクを含むモジュール ページと、クラス定義を説明するページを受け取りましたが、これらのページのいずれにもメソッドが表示されません。を削除する@memberofと、メソッドがモジュール ページに表示されます。クラスのページに載せたいと思います。

jsdoc ドキュメントのどの部分が欠けていますか?

私のモジュールには次の AMD 構造があります。

モジュールで動作させるために JSDoc に苦労しています。今まで、私はそれを次のように機能させることができました

ご覧のとおり、機能しています。しかし、モジュールに追加する場所ではなく、関数宣言でドキュメント コメントを定義する必要があります。私はこれを達成したい:

後者は私が達成したいことですが、残念ながらうまくいきません:(

何か案は？乾杯

編集：

私はいくつかの進歩を遂げました。私がこれだけを書くと、注意してください：

出力は空です。JSDoc はドキュメントを適切に生成できません。ただし、関数に注釈を追加する@method <name>と、自動的にうまく機能します。興味深いですが@method、名前のない注釈のみを追加するだけでは十分ではありません。私の最終的な実用的なソリューションは次のようになります。

CLI フラグ-pにより​​、プライベート メンバーがドキュメントに表示されます。

追加情報

サンプル コードでは、内部リンクを 1 つの方法でしか作成できませんでした。

現在、JSDoc を使用して API の 1 つを文書化しています。これはうまく機能しますが、私が本当に困っていることの 1 つは、重複したドキュメントが発生することです。この一般的な例の 1 つは、プロパティとそのゲッターのドキュメントです。

誰もがここで問題を見ていると思います。プロパティは、実際には 3 回ドキュメント化されています (プライベート プロパティ自体、getter メソッドの説明、およびメソッドの戻り値)。メソッドの説明を次のように単純に変更することReturns the stateは、実際にはオプションではありません。私は通常、ドキュメント出力でプライベート プロパティを非表示にしているためです。

そのような場合のベストプラクティスがあるかどうか、および他の人がこれをどのように処理しているかに興味があります。DRY に取りつかれている人として、これらのケースを処理するためのより良いオプションがあるべきだと思われます。

モバイル アプリに Parse を使用しています。いくつかの Cloud Code 関数があり、JSDoc を使用してドキュメントを生成したいと考えています。

私がこれを行う場合：

JSDoc はドキュメントを生成しません。

ただし、これを行うとうまくいきます：

Cloud Code 関数を文書化することはできますか?

ユニオン内の名前空間とモジュールの目的を理解する際に問題に直面しました。たとえば、クラスがありGame.utils.Matrixます。Game名前空間、utilsモジュール、およびMatrixクラスとして注釈を付けたい:

ドキュメントを作成し、Matrixクラスの名前パスは ですGame.utils~ Matrixが、Moduleリンクをたどると名前パスに名前空間プレフィックスがModule: utilsなく、リンクをたどるとモジュールリンクが含まれていません。GameGameutils

utilsさらに、このクラスはモジュールタブに表示されないため、このモジュールに別のクラスを追加することはできません。

問題は、名前空間とモジュールを文書化する正しい方法と、それぞれのユース ケースは何かということです。