标签 c++ math documentation
<分区>
我想知道在 C++ 代码中记录数学公式的最佳实践。
理想情况下，能够将方程式直接写入注释中是完美的，但以人类可读的方式编写它们是不可行的。
我查看了 LaTex、MathML，当与来自不同领域的许多人一起工作时语法很复杂(毕竟不是每个人都是数学家)。如果您在这方面有任何经验，请发表评论。
例如，我在每个需要记录的函数中添加了对外部 HML 文件的交叉引用，但很难维护。我尝试了 Doxygen 公式，我们大多数人发现语法也非常复杂。
\f[
|I_2|=\left| \int_{0}^T \psi(t)
\left\{
u(a,t)-
\int_{\gamma(t)}^a
\frac{d\theta}{k(\theta,t)}
\int_{a}^\theta c(\xi)u_t(\xi,t)\,d\xi
\right\} dt
\right|
\f]
最佳答案
您始终可以使用“ASCII”艺术。如果您的编辑器支持 Unicode(特别是 UTF-8 编码)，那就更好了。实际查看代码时，它可能更具可读性。虽然维护它可能并不比 TeX 语法容易。例如
// │ ⌠T { } │
// │ | { ⌠a dθ ⌠θ } │
// │ I │ = │ | ψ(t) { u(a,t) - | ------ | c(ξ) u (ξ,t) dξ } dt │
// │ 2 │ │ | { ⌡γ(t) k(θ,t) ⌡a t } │
// │ ⌡0 { } │
关于C++ 嵌入数学公式，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/9001081/