Ddoc


Ddoc
Ddocは、 Walter Brightによって設計された、 Dプログラミング言語用のコンパイラ組み込みドキュメントジェネレータおよび関連する構文です。その重点は、自然なスタイルでコードコメントにドキュメントを記述できるようにすることであり、埋め込まれたマークアップの必要性を最小限に抑え、コードコメントの読みやすさを向上させます。概念的にはDoxygenやJavadocに似ています。
コードコメントはコード内のシンボルに関連付けられており、Ddocは、Dコンパイラから入手できるセマンティックおよび構文情報を使用して、パラメータやリターンタイプなどのルーチン情報を自動的に入力します。
コードコメントとシンボルテーブル情報は、Ddocによって内部構造化形式に処理されます。これらの各構造は、マクロとして表現されたテンプレートに対応しています。テンプレートマクロは、構造化された形式を、マークアップを表現する別のマクロのセットに変換します。後者のマークアップマクロのセットは、デフォルトでHTMLを生成するように拡張されています。マクロとマークアップマクロはどちらもユーザーが上書きでき、HTMLスタイルシートに類似した外部ファイルを介して適用できます。テンプレートマクロを変更して高レベルのフォーマットをカスタマイズしたり、マークアップマクロを変更してXMLやXHTMLなどの他の出力フォームを生成したりできます。

コンパイラオプション
dmd DコンパイラにHTMLドキュメントファイルを出力させるために、いくつかのコンパイラオプションを使用できます。
/-D ドキュメントの生成-出力はDソースファイルと同じ名前になり、拡張子は「.d」が「.html」に置き換えられます。
/-Dd ドキュメントファイルをディレクトリに書き込みます。出力ファイル名は-Dオプションの場合と同じです。
/-Df ドキュメントファイルをファイル名に書き込みます(.html拡張子は自動的に追加されません)

外部リンク
Ddoc仕様
CandyDoc-Ddoc用の高度なマクロのセット
Stub
  このプログラミングツール関連