問題タブ [ngdoc]

クラスを返すファクトリを持つAngularアプリがあるとします。

(角度使用ngdocの特別なフレーバーjsdoc) を使用して、メソッドとして定義せずにイニシャライザーをドキュメント化するにはどうすればよいですか?

今、これは私が試したことです：

しかし、これにより、Userイニシャライザ (Userパラメータ を受け取る関数name) が という名前のメソッドのように扱われることになり、Initializerこのコードを使用しようとする人々を混乱させます。

@constructorフラグを追加しようとしましたが、これは htmldgeniが生成されるという効果はありません。

ありがとうございました。

更新: への参照を削除しましたdgeni。私が使用していたプラグイン ( grunt-ngdocs ) がdgeni舞台裏で使用されているという印象を受けましたが、そうではありません。

ngdocs と grunt を使用して Angular WebApp を文書化しようとしています。ルート構成を文書化する方法があることを知りたいのですが、WebApp のルーティング システムがかなり複雑であり、文書化の部分で注意が必要であると感じているためです。

とにかく、コントローラ、工場などのレベルでそれを持つことができますか.

以下のレベルに配置できますか:

ありがとう、アンキット

API ドキュメントセクションとチュートリアルセクションを含む作業ドキュメント ページがあります。ブレッドクラム ナビゲーションで [チュートリアル] をクリックすると、コンテンツ領域に空白のページが表示され、ブラウザーのタイトル バーに「core-js: エラー: ページが見つかりません!」と表示されます。API ドキュメントボタンでも同じ動作が見られます。

メイン ナビゲーション バーのリンク (またはメインのパンくずリスト) をクリックすると、どのファイルが読み込まれますか? この動作は Gruntfile.js でどのように構成できますか?

Firefox 開発ツールを使用して、対応するファイルの ajax リクエストを監視しましたが、チュートリアルリンクをクリックしてもリクエストが表示されません。Gruntfile.js でいくつかのオプションを試し、tutorial.html ファイルを生成されたドキュメント ディレクトリに配置しようとしましたが、成功しませんでした。

ルート セクションのページにコンテンツを含めることは不可能ですか?

メイン ナビゲーション バーのプロジェクト リンクcore-jsがクリックされたときにIntroページを開くように grunt タスクを構成しました。Tutorialリンクについてはこの動作を歓迎しますが、特定のチュートリアルページが必要です。

私の現在の Gruntfile コード:

grunt-ngDocsによって生成された Web サイトのルックアンドフィール テンプレートを変更するにはどうすればよいですか?

最終的な目標は、生成されたドキュメントを Web サイト内に統合することです。

例として、トピックごとに次のタブを表示します。

• デモ (最終的なユーザー レンダリングに重点を置いています)
• コード (開発者向け)

そのためには、ngDocs で使用されるテンプレートを変更する必要がありますが、どうすればよいでしょうか?

NGDOC で文書化されている大規模な AngularJS プロジェクトがあります。多くのフォームがあり、特定のディレクティブは特定のフォームにのみ含めることができます。これは現在、依存関係として文書化されています。各ディレクティブには、コメント内に @require my.directive:myFormContainerBlaBla が含まれています。このディレクティブ用に生成されたドキュメントには、依存関係セクションの myFormContainerBlaBla への適切なリンクが含まれています。

ただし、myFormContainerBlaBla のドキュメントには、その内部で使用できるディレクティブへの参照は含まれていません。文書化されたディレクティブのメニュー リストもフラットです。それを行う方法はありますか：

1) myFormContainerBlaBla のドキュメントには、@require するすべてのディレクティブへのリンクが含まれています。

2) 文書化されたディレクティブのメニュー リストは、階層的に配置されています。

コントローラーのメソッドを説明できません。どうすればこれを行うことができますか?

ドキュメントの自動生成に ngdoc を使用しています。しかし、私は自分が間違っていることを理解できません。

grunt-ngdocsAngular プロジェクトの文書化に使用しています。ただし、デモの Plunker コード (自動生成) には CSS ファイルが含まれていません。

私の構成には以下がGruntfile.js含まれます：

私のJS srcファイルでは：

API ページで、JS ファイルと CSS ファイルが正しく読み込まれます。ただし、表示されるdemoソース コードには CSS ファイルが含まれていません。

私の API ページでは、デモがうまく機能します。しかし、Plunker にリンクしても、行を含む CSS が存在しないため、目的の結果が得られません。助言がありますか？