問題タブ [ngdoc]

ngdocsを使用して AngularJS アプリケーションを文書化しています。ディレクティブ自体に固有のコントローラーが API に含まれています。これを として文書化しようとしまし@module.directive:dirName.controller:ControllerNameたが、これは適切にタグ付けされていないようで、コントローラーは としてラベル付けされた新しいモジュールの下に文書化されてしまいますmodule.directive:directiveName。これを下に文書化する必要がありmoduleますか？これを行う最善の方法について考えている人はいますか？

を使用して jQuery ウィジェットをドキュメント化するにはどうすればよいgulp-ngdocですか? 私はこのようなものを持っています:

...そして、次のエラーが表示されます:[Error: Don't know how to format @ngdoc: widgets]

gulp ngdocs コマンドを実行したところ、プロジェクト フォルダー構造内に docs フォルダーが作成されました。が読み込まれています。何か不足していますか。助けてください。

Docs フォルダー
css、partials、js、fonts フォルダーおよび index.html内のコンテンツ

私は最近、JavaScript 関連のビルドとバンドルの大部分に webpack を採用することに決めましたが、理解できなかった部分が 1 つあります: webpack を使用して ng-docs を実行するにはどうすればよいですか?

それぞれの ng-doc パッケージを介して grunt と gulp を介して ng-docs を実行できることは承知していますが、既に webpack を利用している場合 (特に必要な場合)、これらのランナーのいずれかに依存したくないことが理想的です。ちょっとしたことを一つだけ）。

webpack を介して ng-docs を実行するもの (ローダーまたはこれを行うための何かと連携するプラグインのようなものを期待していたでしょう)、またはラップできる単純な ng-docs パッケージをインターネットで何度も検索しました。私のwebpack構成内でいくつかのNodeJSコードを使用していますが、何かを見つけることができませんでした。プラグインやローダーを介して webpack を使用できるようなパッケージは存在しますか? コマンドラインから ng-docs を実行できるパッケージはありますか?

ファイルシステムからgrunt-ngdocs自動的に生成された を提供することはできますindex.htmlが、取得しているドキュメントの説明を見ようとするたびに:

docs/partialsとdocs/partials/apiフォルダの両方が空の場合でも。

これが私のgrunt-ngdocs構成です

私は何を間違っていますか？

前もって感謝します

「ファクトリ関数」を返す「Angular ファクトリ」を文書化するために ngdoc を使用するにはどうすればよいですか? 具体的には、「ファクトリ関数」が作成するオブジェクトをどのように文書化しますか?

以下の不自然な例では、ファクトリを使用してページ オブジェクトを作成する方法を文書化しましたが、ページ オブジェクト自体の使用方法を文書化するにはどうすればよいでしょうか?

私が SO で見つけることができる最も近い一致は次のとおりです。. 疑似古典的な継承を使用していないため、メソッドをリンクするための「クラス」名がないため、これは役に立ちません。

私は AngularJS コンポーネントを作成していますが、コンポーネント自体とコントローラー関数の両方に ngdoc 注釈を追加する正しい方法は何だろうと思っていました。

例はありますか？