【doxygen】doxygen 支持 markdown 公式

配置 doxygen

在 Doxygen 配置文件(通常是 Doxyfile )中,确保以下选项已启用或设置:

  • MARKDOWN_SUPPORT :设置为 YES ,以启用对 Markdown 文件的支持。
    在这里插入图片描述

  • USE_MATHJAX :设置为 YES ,以使用 MathJax 渲染数学公式。
    在这里插入图片描述

markdown 文件中插入公式

在段落中插入公式

\f$(x_1,y_1)\f$ and \f$(x_2,y_2)\f$ is \f$\sqrt{
    
    (x_2-x_1)^2+(y_2-y_1)^2}\f$
\f$g=\frac{
    
    Gm}{
    
    r^2}\f$

公式居中显示

\f{
    
    eqnarray*}{
    
    g=\frac{
    
    Gm_2}{
    
    r^2}\f}

公式分行显示

\f{
    
    eqnarray*}{
    
    
g &=& \frac{
    
    Gm_2}{
    
    r^2} \\
&=& \frac{
    
    (6.673 \times 10^{
    
    -11}\,\mbox{
    
    m}^3\,\mbox{
    
    kg}^{
    
    -1}\,
\mbox{
    
    s}^{
    
    -2})(5.9736 \times 10^{
    
    24}\,\mbox{
    
    kg})}{
    
    (6371.01\,\mbox{
    
    km})^2} \\
&=& 9.82066032\,\mbox{
    
    m/s}^2
\f}

效果展示

在这里插入图片描述

参考链接

https://www.doxygen.nl/manual/formulas.html

猜你喜欢

转载自blog.csdn.net/tyustli/article/details/131450353