ドック

Ddoc は、 D プログラミング言語のドキュメント生成テクノロジであり、 Dコンパイラの機能として提供されます。Ddoc は、 DoxygenやJavadocなどの他のドキュメント生成テクノロジに似ています。

ドキュメント生成ツールではよくあることですが、Ddoc はコメントとシンボリック (非コメント) コードに基づいてソース コードからドキュメントを生成します。コード内のコメントの可読性を最大限に高めるために、Ddoc では埋め込みマークアップをあまり使用しません。パラメータや戻り値の型などの共通情報にはシンボリック コードを使用します。これにより、一部のドキュメント生成ツールで要求されるようなコメント内の情報の繰り返しが不要になります。

Ddoc は、テンプレートマクロを適用してコメントとシンボリック情報を処理します。これにより、間接的にHTMLなどの最終表現が生成されます。テンプレート マクロは、 HTML スタイル シートに類似した外部ファイルを介してカスタマイズできます。これにより、すべての出力表現の書式設定をカスタマイズしたり、 XMLやXHTMLなどの他の表現を生成したりできます。

ドキュメント生成を制御するための D コンパイラ (dmd) オプション:

• /-Dドキュメントを生成することを選択します。出力はデフォルトでソースファイルと同じ名前で拡張子が「.html」のファイルになります。
• /-Dd<directory>ドキュメントファイルを保存するディレクトリを指定します
• /-Df<filename>ドキュメントを書き込むファイル名を指定します

• Ddoc仕様
• CandyDoc - Ddoc 用の高度なマクロのセット