Doxygen：コードのドキュメント付け
コードのドキュメント付け 特殊ドキュメント・ブロック 特殊ドキュメント・ブロックは、C または C++スタイルのコメントブロックにマークを付け加えたもので、Doxygenはこれをドキュメント断片と認識して、ドキュメントを生成します。 PythonとVHDLコードについては、別のコメント表記規則があります。セクションPython での特殊ドキュメント・ブロック と VHDL での特殊ドキュメント・ブロック で説明します。 各コード要素について、説明形式が2（3の場合も）種類あり、これらがドキュメントを形成します。それは、要約説明と 詳細説明で、どちらもオプションです。メソッドと関数については、もうひとつの形式があり、いわゆる"本文内"説明で、メソッドや関数の本体内のコメントブロックの連結からなります。 ひとつ以上の要約説明または詳細説明を指定できます。（ただし、出現順序が指定されていないため
Doxygen
特徴 ドキュメントの執筆者に対して、非常に少ない労力しか要求しません。 プレーンテキストでも充分ですが、装飾や構造化が出力に必要であれば、HTMLタグや特殊コマンドを使うことができます。 C/C++、Java、(Corba およびマイクロソフト) Java、Python、 IDL、C#、Objective-C をサポートしており、D と PHP のソースにもある程度対応しています。 ファイル、名前空間、パッケージ、クラス、構造体、共用体、テンプレート、 変数、関数、typedef、列挙、およびマクロ定義のドキュメントに対応しています。 JavaDoc (1.1)、Qt-Doc、および ECMA-334 (C# 仕様) と互換。 クラス図とコラボレーション図をHTML形式 (クリック可能なイメージマップ) と (Encapsulated PostScript イメージ)で自動生成します。 G
Doxygen
ソースコード・ドキュメンテーション・ツール Doxygen は、C++、C、Java、Objective-C、Python、IDL (Corba、Microsoft 風)、Fortran、VHDL、PHP、C# 向けのドキュメンテーション・システムです。 D にもある程度対応しています。 Doxygen には、次の３つの利点があります。 文書化されたソースファイルのセットから、 オンライン・ドキュメント・ブラウザ (HTML形式) やオフラインのリファレンス・マニュアル (形式) を生成することができます。 RTF (MS-Word)、PostScript、ハイパーリンク PDF、圧縮 HTML、Unix man ページ形式の出力もサポートされています。ドキュメントは、ソースから直接抽出されます。これにより、ドキュメントとソースコードの一貫性を保つことがとても容易になります。 Doxyge
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
