ナチュラルドキュメント

ナチュラルドキュメント
ナチュラルドキュメント
原作者	グレッグ・ヴァリュール
安定版リリース	2.3 / 2023年9月11日
リポジトリ	github .com /NaturalDocs /NaturalDocs;
書かれた	C# ( Perl 2.0以前)
オペレーティング·システム	クロスプラットフォーム
タイプ	ドキュメントジェネレーター
ライセンス	AGPL
Webサイト	ナチュラルドックス

Natural Docsは、多言語対応のドキュメント生成ツールです。C #で記述されており、 AGPLの条件に基づきフリーソフトウェアとして利用可能です。ソースコード内のコメントも、生成されたドキュメントと同様に読みやすいように配慮されています。Greg Valureによって開発・保守されています。

背景

理論上、Natural Docsはコメントをサポートできるあらゆる言語、あるいはプレーンテキストファイルからドキュメントを生成できます。実行すると、ActionScript、C#、Perlの関数、変数、クラス、継承について、ソースコード内の既存のドキュメントの有無にかかわらず、自動的にドキュメントを生成します。その他の言語では、これらを生成するには明示的にドキュメントを記述する必要があります。HTML 形式では、フレーム付きでもフレームなしでもドキュメントを生成できます。

Javadocとは異なり、あらゆる言語のドキュメント作成における業界標準とは見なされていませんが、「完全サポート」の言語のJavadocドキュメントを組み込むことができます。^{[ 2 ]} CNET Networks, Inc.やIron Realms Entertainmentなど、一部の愛好家や企業で使用されています。^{[ 3 ]}^{[ 4 ]} ActionScriptを完全にサポートする無料のドキュメントジェネレーターは他に存在せず、 ROBODocなどの言語を部分的にサポートする同様のジェネレーターよりも高品質の出力を生成するため、ActionScript開発者の間で人気が高まっています。

例

これはドキュメントスタイルの例です。

/*  * 機能: Multiply  *  * 2 つの整数を乗算します。 *  * パラメータ:  * x - 最初の整数。 * y - 2 番目の整数。 *  * 戻り値:  * 乗算された 2 つの整数。 *  * 参照:  * <Divide>  */ int Multiply ( int x , int y ) { return x * y ; }

比較のために、同じことをJavadocで文書化すると次のようになります。

/**  * 2 つの整数を乗算します。  *  * @param x 最初の整数。  * @param y 2 番目の整数。  * @return 乗算される 2 つの整数。  * @see Divide  */ int Multiply ( int x , int y ) { return x * y ; }

参照

ドキュメントジェネレータの比較

注釈と参考文献

^ Natural Docsについて
^ Natural Docs 言語
^ CNET Networks, Inc.によるCNETのグローバルフレームワークとNatural Docsを使用して生成されたドキュメント
^ Iron Realms EntertainmentによるRaptureとNatural Docsを使用して生成されたドキュメント

さらに読む

[1] Natural Docsについて

[2] Natural Docs 言語

[3] CNET Networks, Inc.によるCNETのグローバルフレームワークとNatural Docsを使用して生成されたドキュメント

[4] Iron Realms EntertainmentによるRaptureとNatural Docsを使用して生成されたドキュメント

[ 1 ]

[ 2 ]

[ 3 ]

[ 4 ]