ナチュラルドキュメント

ナチュラルドキュメント

原作者	グレッグ・ヴァリュール
安定リリース	2.3 / 2023年9月11日
リポジトリ	github.com/NaturalDocs/NaturalDocs
書かれた	C# ( Perl 2.0以前) [1]
オペレーティング·システム	クロスプラットフォーム
タイプ	ドキュメントジェネレーター
ライセンス	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 ホームページ
• 機能一覧
• サポートされている言語のリスト