我想在使用 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 库),或者您可以尝试在文档中编写 MathML https://developer.mozilla.org/en-US/docs/Web/MathML/Authoring ...
您也可以尝试使用各种 unicode 字符,returns X + √2
但也非常有限。
但所有这些都是围绕 ddoc 工作的,而不是使用它。ddoc 无法自行完成。