問題タブ [jsdoc3]

次のコマンドを実行します。

これが私が得たものです。正規表現にエラーが見つかりません：

@event タグを適切に使用する方法の例を教えてください。

ここで jsdoc3 のドキュメントを見てきました: http://usejsdoc.org/tags-event.html ですが、動作させることができませんでした。

私はnodejsを使用しています.MyClass/index.jsにMyClassという名前のコンストラクタをエクスポートするモジュールがあります:

そして私は追加しようとしました

コンパイルされたドキュメントでsnowballは、イベントのグローバル リストに表示されますが、クリックすると表示されます

前もって感謝します。

@type に関するUseJSDoc.orgのページでは、配列とオブジェクトを文書化する方法について説明していますが、オブジェクトの配列については説明していません。私の関数は、特定のプロパティ リストを持つオブジェクトの配列を受け入れます。これらのプロパティを文書化したいと思います。

関数は次のようにfunction foo(people)なり、people配列は関数の呼び出し元によって次のように作成された可能性があります。

オブジェクトを文書化するために構文を使用したい{{name: string, profession: string, hitpoints: number}} Personのですが、オブジェクトが配列に含まれている必要があるという概念も含めたいと思います。

基礎となるオブジェクト (コードは何も参照しませんが、上記で呼び出しPersonたもの) は適切なクラスではなく、どこにも名前が付けられていないことに注意してください。また、 @propertyタグを使用するための単一の " Person" がどこにも定義されていません。

この種のコードを JSDoc3 でドキュメント化することの難しさは、整理が不十分であることを示唆している可能性があります。主にハッシュ テーブル (連想配列) として使用される、このような一時的なオブジェクトを再編成する方法についてアドバイスをいただければ幸いです。

文字列の配列の配列があり、それを JSDoc で文書化する方法がわかりません。

エラーが発生します。

無効な型式 "string[][]": "!"、"?" が必要です または「|」しかし、「[」が見つかりました。

?そして、それがnullになる可能性があることを示すために型の前に置くべきかどうかわかりません。

JSDOCの関数引数で可能な構成プロパティを文書化するにはどうすればよいですか:

cfg.minimaxDepth( cfg.*) パラメータに使用するマークアップはどれですか?

合成aiCfg型を文書化し、それを次のように参照することは可能ですか:

またはどういうわけか？

次のコードフラグメントを文書化する方法は? そのまま放置するとFoo.bar何の説明もありません。タグを追加する@memberofと、静的プロパティとして文書化されます。@instanceタグを追加しても何も変わりません。これはかなり単純で一般的なコード パターンなので、簡単に文書化できるはずですよね? 私はjsdocが嫌いです...

このモジュールを説明する最良の方法を教えてください:

この例では、 @public および @static アノテーションは無視され、すべての @public メソッドは「inner」としてマークされ、@private メソッドは「private、inner」としてマークされ、return ステートメントは無視されます。生成されたドキュメントでは、API (コード内の「エクスポート」オブジェクト) として使用できるメソッドと、返されるかどうかがわかりません。

この API はドキュメントに表示されません。

生成されたドキュメント: