1

DDoc でマークアップされた D プログラムから生成された HTML ページで、より豊富なカラーリングとタイプ設定を使用することはできますか? デフォルトは白黒です。

私は現在DMDを次のように呼んでいます

dmd -debug -gc -unittest -D -Dd$OUTPUT_DIR
4

2 に答える 2

1

クラス名と ID を使用するために、新しい ddoc マクロをオーバーライドまたは作成する独自の .ddoc 構成ファイルを作成できます。次に、CSS を使用してページのスタイルを設定できます。

カスタム CSS を含むサンプル .ddoc ファイル。HTML セクションのtheme.cssファイルに注目してください。head

DDOC = <!DOCTYPE HTML>
<html>
    <head>
        <meta http-equiv="content-type" content="text/html; charset=utf-8" />
        <link type="text/css" href="theme.css" rel="stylesheet" media="all" />
        <title>$(TITLE)</title>
    </head>
    <body>
        <h1>$(TITLE)</h1>
        $(BODY)
    </body>
</html>
H2 = <h2>$0</h2>
H3 = <h3>$0</h3>
STRONG = <strong>$0</strong>
EM = <em>$0</em>
DDOC_DECL = $(H2 $0)
DDOC_DECL_DD = <div class="declaration-description">$0</div>

DDOC_CLASS_MEMBERS = <div class="class-members">$0</div>
DDOC_SUMMARY = $(P $0)
DDOC_DESCRIPTION = $(P $0)

DDOC_MEMBERS = <div class="members">$0</div>
DDOC_ENUM_MEMBERS = <div class="enum-members">$0</div>
DDOC_MODULE_MEMBERS = <div class="module-members">$0</div>
DDOC_STRUCT_MEMBERS = <div class="struct-members">$0</div>
DDOC_TEMPLATE_MEMBERS = <div class="template-members">$0</div>

このファイルをどこかに保存し、次のようにsc.iniファイル (Windows の場合) またはdmd.confファイル (Mac/Linux の場合) に追加する必要があります。

DDOCFILE=myproject.ddoc

次に を使用してコンパイルする-Dと、HTML は組み込みのものや viola ではなくカスタム ddoc マクロから読み取られ、CSS で使用するスタイル可能なクラス名と ID が得られます。

カスタム スタイル シートとマクロを使用したきれいなドキュメントのプレビューを次に示します。

HTML ファイル: https://github.com/nomad-software/dunit/tree/master/docs/dunit

完全な ddoc マクロのリストは、http://dlang.org/ddoc.html にあります。

于 2014-01-01T14:42:01.520 に答える
1

おそらく、 http://dlang.org/ddoc.htmlを読んで詳細を確認する必要がありますが、最終的に必要なのは、ページの表示方法を指示する css ファイルです。DDOCマクロで設定できます。

私がお勧めするのは、https://github.com/D-Programming-Language/dlang.orgを見ることです。これには、ddoc を含む dlang.org のコードが含まれています。特に、css、images、およびjsフォルダーと共にstd.ddocを取得する必要があります (これらはすべてstd.ddocによって参照されるため)。次に、ドキュメント ビルドの一部としてstd.ddocを dmd に渡し、それらのフォルダをドキュメントの親ディレクトリに置くと、生成されたドキュメントは dlang.org のドキュメントのようになります。フォルダーを別の場所に配置する場合は、 std.ddocでフォルダーへのパスを微調整します。

ドキュメントの外観を変更したい場合は、それに応じてstd.ddocと css ファイルを調整してください。その時点で、扱っているのは html と css のものなので、std.ddocのいずれかのマクロに必要な変更を加えるためにそれらがどのように機能するかについての手がかりが必要です。またはcssファイル自体に。そしてもちろん、js ファイルで何かをしたい場合は、javascript を知っている必要があります。必要に応じて、すべての js とイメージを取り除くことができます。それらは dlang.org で使用されるものにすぎませんが、これをどう処理するかを知るには、html とその仲間がどのように機能するかについての手がかりが必要です。私はそのどれにも特に精通しているわけではないので、ドキュメントを生成するときは、通常、dlang.org が使用するものに最小限の変更しか加えていませんが、通常探していたのは、より読みやすい色を取得することだけです。特定のものではなく、デフォルトよりも。

申し訳ありませんが、それ以上に具体的または役立つことはできませんが、Web 開発についてほとんど何も知らないので、dlang.org のようなページを取得するのに十分なほどつまずきました。うまくいけば、これはあなたを正しい方向に向けるでしょう。

他に検討したいのはddox です。これは ddoc コメントを使用して、dmd よりも見栄えの良いドキュメントを生成します。そして、dlang.org は、比較的近い将来、ddox で生成されたドキュメントを使用するように切り替える可能性があります (詳細の一部はまだ整理する必要があるため、正確な時期はわかりませんが、それが現在の計画です)。そのため、最終的には、dmd を使用してドキュメントを生成するよりも、ddox を使用する方が一般的になる可能性があります。

于 2013-09-07T11:48:04.357 に答える