自然文書

Natural Docs - オープンソース、拡張可能、多言語ドキュメントジェネレータ
今すぐダウンロード

自然文書 ランキングとまとめ

広告

  • Rating:
  • ライセンス:
  • GPL
  • 価格:
  • FREE
  • 出版社名:
  • Greg Valure
  • 出版社のWebサイト:
  • http://www.naturaldocs.org/about.html
  • オペレーティングシステム:
  • Mac OS X
  • ファイルサイズ:
  • 336 KB

自然文書 タグ


自然文書 説明

Natural Docs - オープンソース、拡張可能、多言語ドキュメンテーションジェネレータ Natural Docsは、オープンソース、拡張可能な多言語文書ジェネレータです。あなたはちょうどあなたのコードを自然な構文で文書化する必要があります。 Natural Docsはあなたのコードをスキャンして高品質のHTML文書を作成します。 "Natural Docs"の重要な機能はいくつかあります。ほぼ透明です。ソースコード内のコメントは、生成されたドキュメントと同じくらい簡単に読み取られます。タグがほとんど派遣されていません。複数の言語:・Natural Docsは、同じプロジェクト内でさえも、箱から出しているプログラミング言語をサポートしています。それは彼らのhbang行によって彼らの言語を決定することができるので、それはCGIと拡張なファイルをサポートしています。あなた自身の言語を追加する:・プログラミング言語がNatural Docsにまだ含まれていない場合は、構成ファイルを編集するだけでサポートを追加できます。最もあいまいな言語でさえも強力なドキュメンテーションジェネレータを持つことができます。全部または単なる明示的なドキュメント:・あなたの言語サポートのレベルによっては、Natural Docsのすべてがすべて文書化されているものの間で選択することができます。これはAPI参照の生成に適しています。柔軟なキーワード:・Natural Docsには、そのトピックタイプごとに多くのキーワードがあり、自分にとって最も自然なものは何でも使用できます。既存のものをカスタマイズしたり、自分のものを追加することもできます。カスタムトピックとインデックス:・Natural Docsが知らないコードのいくつかのファセットを文書化したい場合 - 多分あなたの言語やプロジェクトに特有のものです - あなたはそれのためにあなた自身のトピックタイプとキーワードを作成することができます。 Natural Docsはそれをビルドすることさえそれを自分のインデックスで構築します。リスト:・Natural Docsは、定数のような小さなアイテムの大きなグループを文書化するための省略形の構文を提供します。それぞれのトピックがあるかのように、それぞれがリンク可能なシンボルになります。生成されたoutputAttractiveドキュメント:・ほとんどの生成されたドキュメントとは異なり、Natural Docsの出力はデフォルトで専門的に見えます。から選択するためのさまざまなスタイルがあります。強力なCSS構造:・Natural Docsには、完全なカスタマイズを可能にする強力でよく文書化されたCSS構造があります。デフォルトのスタイルは必ずしもそれを表示しないが、関数へのリンクが1つのスタイルであり、クラスへのリンクが別のスタイルになるようなものを実行できます。レンダリングクイークを回避するために、単一のCSSファイルにブラウザ固有のスタイルを持つこともできます。透過的にMugned Eメールアドレス:・ドキュメントの外観に表示されている電子メールアドレスは、通常の電子メールリンクのように機能しますが、スパムクローラを避けるために透過的に刻印されています。すべての場所にあるツールチップ:・すべての文書化されたトピックへのすべてのリンクには、その要約がツールチップとしてあります。関数と変数へのリンクには、ツールチップ内に完全にフォーマットされたプロトコイがあります。額入りまたは未辞書のHTML:・あなたのドキュメントですのでそれはあなたの選択です。すべてのページを独立してリンクできるようにすることも、ナビゲーションを容易にするためにメニューを別のフレームに保持することもできます。インデックスのプレフィックスを無視します。・一般的な接頭辞はあなたの索引を台無しにする必要はありません。すべてのクラスがCから始まる場合、またはCOM_で始まる機能の束がある場合は、Natural Docsを無視することができます.CCAT、CDOG、およびCMACEはC、D、およびMouseがすべてC.プログラムの代わりにC、D、およびMに表示されることができます。高度に自動化された:・Natural Docsは、ソースツリーのどの部分が変更され、それに応じて文書を調整します。自分でやらない場合は、メニューを自動的に維持管理します。コマンドラインまたは構成ファイルの変更が必要な場合は、自動的にドキュメントを再構築します。差動ビルドプロセス:・Natural Docsは、最後の実行以降に変更または追加されたファイルと、それらに依存するファイルを劇的に削減し、より大きなプロジェクトに適しているファイルを構築します。 Extensibleアーキテクチャ:・Natural Docsは、さまざまなプログラミング言語、トピック、およびCSSスタイルのために簡単に拡張されるように設計されています。これはすべてこのサイトに記載されています。インテリジェントな設定ファイル:・Natural Docsは設定ファイルに変更された変更を検出し、より小さな詳細自体を処理します。彼らは自動的に再フォーマットされているので、迅速で汚れた編集をすることができ、それでも読みやすさを維持することができます。プロジェクト構成ファイルメインファイルで定義されているものの最新のリストを保持してください。ポータブル:・Natural DocsはPerlが実行されていますが、それはかなり多くの場所です。無料でオープン:・Natural DocsはGPLの下でライセンスされているので、無料ではありません。


自然文書 関連ソフトウェア