問題タブ [grunt-ngdocs]

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

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

私のJS srcファイルでは：

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

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

私は現在、grunt-ngdocs で ngdocs 構文を使用している、私の最初の実際の AngularJs アプリを文書化する過程にあります。

私のサービスメソッドがプロミスを返すことに注釈を付けるためのより良い方法があるかどうか疑問に思っていました（したがって、戻りオブジェクトにアクセスする代わりに .then() を追加する必要があることがわかります.

サービスの完全なコンテキスト:

Angular プロジェクトで ngDoc を使用して動作する基本的な例を取得しようとしています。

以下に例を示します。

ドキュメントがコンパイルされると、例のタイトルが表示されますが、埋め込まれた例はありません。

コンパイルされたドキュメントへのリンクは次のとおりです。

http://thinkingmedia.github.io/thinkingmedia-ui/#/api/ui.components.uiRepeat

例がどのように見えるかを示す Angular ドキュメントへのリンクを次に示します。

https://docs.angularjs.org/api/ng/directive/ngClick

ngDoc の何が問題なのですか?

私の css スタイルシートを ngdocs ドキュメントのライブ デモの例に追加したいと思います。

スタイルがデモ自体に影響を与えることを望んでいますが、明らかに、Web ページ全体に影響を与えるべきではありません。

次のように、スタイルシートを gruntfile ngdocs オプションに追加してみました。

これにより、head セクションに最後に含まれるリンク タグとして mylayout.css が index.html のマークアップにリンク タグとして追加されますが、その中のスタイルはページ全体のスタイルをオーバーライドします。ダメ。

スタイルがライブ デモ内で機能し、ページの残りの部分では機能しないようにするにはどうすればよいですか?

ご協力いただきありがとうございます！これが ng-docs で入手できる非常に限られた情報に貢献することを願っています!

編集:私がやったことは、myNgdocsLayout.css という名前の新しい css ファイルを作成することです。このファイルでは、mylayout.css スタイルをライブデモに適用できるようにしながら、mylayout.css の一部をオーバーライドするいくつかのスタイルを記述しました。

これで私のページは問題ないように見えますが、これは完全な解決策ではありません。ページの残りの部分でスタイルをオーバーライドする必要なく、スタイルをライブデモにのみ適用できるようにするアイデアを誰かが思いつくことができれば幸いです... -ngdocsでこれを行う方法。

私はコードのドキュメントを作成するのが初めてで、角度のあるアプリケーションを grunt-ngdocs でドキュメント化しようとしています。

https://github.com/m7r/grunt-ngdocs-exampleから実際の例を複製しました

与えられた例には文書化されたコントローラーがないため、次のコードを使用して独自の文書化されたコントローラーを追加しました。

コマンド ラインから grunt を実行してドキュメントを作成しようとすると、次のエラー メッセージが表示されます。

これを修正するにはどうすればよいですか? このガイドhttp://www.shristitechlabs.com/adding-automatic-documentation-for-angularjs-apps/を読みましたが、コントローラーを文書化しようとするとエラーメッセージが表示され続ける理由がわかりません:(ありがとうどんな助けでも！

私は角度のあるアプリケーションに grunt-ngdocs を使用して把握し始めたばかりで、これまでのところうまくいっています。

しかし、コントローラーの 1 つで別の文書化されたプロパティのいくつかのプロパティを文書化したいと思います。

次のコードを検討してください。

ご覧のとおり、いくつかのプロパティが vm 変数からぶら下がっています。これらは通常、コントローラーで定義された関数への参照です。

上記の ngdocs\jsdocs ドキュメント構文を使用すると、vm プロパティをドキュメント フォルダに出力できますが、vm オブジェクト自体のプロパティをドキュメント化する方法がわかりません。

これを行うための賢明な、または推奨される方法はありますか? vm を完全に文書化せず、それぞれの vm.xxx を個別に文書化することについて疑問に思いましたが、これについてはよくわかりません!

ありがとう

こんにちは、grunt-ngdocs を使用してディレクティブの例を作成しようとしています: https://github.com/m7r/grunt-ngdocs

example タグのドキュメントは非常に貧弱であるため、ng-docs にも plnkr にもない実際の例を作成できませんでした。

私の例は次のようになります。

ディレクティブは実行時にうまく機能します。問題は、私が書いたソフトウェアのドキュメントの例を作成することだけです。

plnkr はここにあります:

http://plnkr.co/edit/2ZnWoCAyRPfEzPJ07Qph?p=preview