16

JSDocがHTML形式で（ディレクティブ、コントローラー、フィルターなどの）素敵なコメントを生成できるようにangularjsプロジェクトを文書化/構造化した経験のある人はいますか？現時点では、いくつかの関数を使用してアプリの名前空間を指す_globalクラスを含む1つのファイルを生成し、それだけです...

または、angularjsでHTMLバージョンのドキュメントブロックを生成するためのより良い方法がありますか？

PS：コードを文書化するために標準のjsdoc構文を使用しています（@ param、@ returnなど）

更新：私の具体的な質問は次のとおりです：すべてのコントローラー/ディレクティブ/フィルターなどをカバーするangularjsドキュメントブロックのhtmlドキュメントを生成する方法はありますか？JSDocコマンドラインユーティリティを実行すると、HTMLレポートのコードの約5％しかカバーされませんでした...

ありがとう！

4

3 に答える 3

33

私はAngularJSのドキュメント生成コードを利用するgruntプラグインに取り組んできました。それは彼らの構文と出力に従います。うなり声-docular。リンクは、元のAngularJSソースだけでなくdocularソースのドキュメント生成も示しています。構成可能で拡張可能です。

grunt-docularに移動し、独自のドキュメントを作成する例のインストールリンクを見つけます

于 2013-04-23T12:28:15.707 に答える
4

編集：以下のジョンデビッドファイブの答えを参照してください

私の答えはずっと古く、もはや受け入れられるべきではありません。

于 2012-10-11T16:21:32.120 に答える
1

ビルド手順：

ドキュメントはbuild/docsフォルダで利用できます。PHP 5.5を使用している場合は、次のコマンドで表示できます。

  • cdビルド
  • php -S localhost：8000
  • ブラウザで表示：http://localhost:8000/docs/index.html
于 2013-11-19T08:00:38.740 に答える