DDoc を使用してドキュメントで数式を使用したいと考えています。見栄えを良くする良い方法は何ですか?
何かのようなもの:
/**
* Returns x + sqrt(2).
*/
double add_sqrttwo(double x) {
return x + sqrt(2);
}
MathJax をインポートしてから、\(
\)
またはの間に数学を配置でき\[
\]
ます。
例:
/**
* Macros:
* DDOC =
* <!DOCTYPE html>
* <html lang="en-US">
* <head>
* <script type="text/javascript" async src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-MML-AM_CHTML"></script>
* <title>$(TITLE)</title>
* </head>
* <body><h1>$(TITLE)</h1>$(BODY)</body>
* </html>
*
*/
module example;
import std.math;
/**
* Jay! \( a + \sqrt{2} \)
*
* You must prefix parameter names with an underscore: \( _x + \sqrt{2} \).
*
*/
double add_sqrttwo(double x) {
return x + sqrt(2.0);
}
残念ながら、DDOC 自体はこれを行うことができません。これを行うには、Javascript などを使用するか、画像として事前に生成する必要があります。
HTML をターゲットにしている場合は、いくつかのオプションがありますが、それ自体は ddoc ではありません: 数式 ( <img src="...">
) を使用して画像にリンクできます。画像をタグで囲み、後で処理できます (生成ステップでポスト プロセッサを使用するか、 Web 上の Javascript ライブラリ)、またはドキュメントhttps://developer.mozilla.org/en-US/docs/Web/MathML/Authoring ...で MathML を記述してみることができます。
のようなさまざまな Unicode 文字を使用することもできますがreturns X + √2
、それもかなり制限されています。
しかし、これらはすべて ddoc ではなく、ddoc を使用して動作しています。ddoc だけではできません。