問題タブ [jsdoc3]

JSDoc3 を使用してファイルに関するドキュメントを生成しようとしていますが、問題が発生しています。ファイル (Require.js モジュール) は、基本的に次のようになります。

baz問題は、生成されたドキュメントに表示されないことです。代わりに、メンバーfoo/fooをリストするモジュールのドキュメント ファイルを取得するだけですが、メンバーはありません(のソース コードへのリンクのみ)。barbarbazfoo

barのディレクティブを@property代わりに変更しようとしましたが、のディレクティブをまたはに変更しようとしましたbazが@member、@propertyどれも役に立ちません。私が何をしても、baz は現れたくないようです。

生成されたドキュメントに baz を表示するために使用できるディレクティブ構造を知っている人はいますか?

PS JSDoc サイトhttp://usejsdoc.org/howto-commonjs-modules.htmlでこのようなページを読んでみましたがfoo.bar、 ではなくのケースのみを説明していfoo.bar.bazます。

私の JS ライブラリでは、アンダースコアで始まるファイルが JSDoc3 からの出力に表示されていないことに気付きました。これらは @module を使用してマークされており、@public を追加して -p スイッチを使用してビルドしようとしましたが、表示されないようです。これを解決する方法はありますか？

質問: コードに JSDoc タグが含まれるオープン ソースの JavaScript ライブラリを編集して使用しています。JSDoc タグからクラス図を生成できる JSDoc プラグインを知っている人がいるかどうか疑問に思っていました。

編集js/umlを試してみることにしましたが、次のことがわかりました。JS/UML Eclipse 拡張機能には、古いバージョンの Eclipse (Indigo) と、サポートされていない依存ライブラリ UML2tools が必要です。必要な依存関係が見つかり、Eclipseソフトウェアマネージャーが正しくインストールされていることがわかりました。(js ルートを構成して) UML 機能を有効にしようとすると、プロセスがハングします。グループが提供する例は、単一ファイル Javascript を指しています。複数のファイルを参照すると問題が発生するようです。

このパターンに従うモジュールがあります。

次に、Filters モジュールのサブモジュールがあります。

サブモジュールを文書化する方法がわかりません。私はいくつかの検索を行いましたが、jsdoc スタイルのコメントで文書化されているこの特定のパターンに従う人は他に見つかりませんでした。どんな助けでも大歓迎です。

JsDoc にソース リンクを除外させる最も簡単な方法は何ですか? 独自のテンプレートを定義する必要がありますか?

ファイルlib.jsがあります：

およびtest.js

ファイル test.js の「x」変数のドキュメントを取得できません。それ以外の方法でクラスをインポートすると、すべてが機能します。

開発には intellij idea 13 を使用します。

クラスで使用される単なるミックスインである複数のスタンドアロン モジュールがあります。

基本的に、私の構文はまさにこれです：

ファイルは mixin として検出されますが、API 記述内でメソッドが関連付けられていません。

JsDoc 3.3 を使用していますが、これが機能しない理由がわかりません。

コンストラクターを返す JavaScript 関数があります (以下のコード サンプルを参照)。jsdoc の @returns タグを使用してこれを文書化するにはどうすればよいですか。@returns {MyConstructor} を実行するのは正しくないようです。これは、コンストラクター自体ではなく、"MyConstructor" のインスタンスを返すことを意味するからです。

JSDoc は、各ページのフッターに日付を出力します。

そのため、ライブラリを再構築するたびに、すべてのドキュメント ファイルが Git に変更されたように見えます。これは望ましくありません。実際に内容が変更されたときにのみ、これらのドキュメントをコミットしたいと考えています。

JsDoc がこのフッターをまったく出力しないようにすることはできますか?