公式

Doxygen允许你把公式显示在最终的输出中（这个功能仅限于HTML和输出）.为了可以在HTML documentation显示公式（转化为图片），你必须安装以下软件：

latex: 编译器, 被用来解析公式, 首先提取公式写到一个_formulas.tex文件里,再用编译成DVI格式.
dvips: 转化DVI文件到 PostScript.
gs: GhostScript 转换PostScript 文件为 bitmaps.这样就可以显示在网页了。

以上三个软件可以单独安装，可参考<<Including formulas>>,不过我是在windows环境下使用的，实际上只需要装一个CTEX程序，以上三个软件均会被装上。

对于HTML输出，还有一种办法就是使用MathJax，它不要求以上工具。如下图，我们选取USE_MATHJAX即可。

使用公式有三种方法：

使用行内公式，即在文本之间使用公式。这些公式将被放在一对 \f$ 之间。
```
 The distance between \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$.
```
显示为：The distance between and is .

使用行间公式，即公式单独成一行。这些公式将被放在一对 \f[ 和\f]之间。

  \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]

显示为：

3. 使用environment，至于什么是environment，可以查询Latex的语法。语法是以 \f{environment}开始，以\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}

显示为：

Note:

有时候我们在编译Latex公式时需要某些包支持，而Doxygen调用Latex时仅仅调用了epsfig、graphicx、keyval、graphics、dvips等几个基本的包
其他如amsmath这种常用的包都没有调用。所以如果要排版数学公式的话需要手动把需要的包加进来。

在Linux环境下直接修改doxygen的配置文件即可，在windows下需要通过图形界面，在Expert->LaTeX->EXTRA_PACKAGES填入amsmath、xr、amsfonts三个包即可。

效果：

我在libtest的test-helper.h使用了数学公式，可以查看效果。

参考文献：

1.《Doxygen Including formulas》

2.《使用doxygen排版数学公式出错的解决方法》

DOxygen for C++使用说明——添加数学公式相关推荐

DOxygen for C++使用说明——Markdown支持
自Doxygen 版本1.8.0,Markdown被引进. 接下来,我们将先简单介绍标准的Markdown语法,读者可以进入Markdown官网查询更详细的细节.然后讨论一下Doxygen支持的Mar ...
addroutes没添加进去_CAD中如何绘制函数曲线及添加数学公式
如何在CAD中绘制函数曲线?CAD与EXCELL结合,绘制函数曲线相当厉害.本文采用中望CAD软件,举例说明方法: 一.以三角函数y=sinx为例. 1.在A列从0开始以步长0.4(可自行调节)取若干 ...
【经验分享】Typora如何添加数学公式
[经验分享]Typora如何添加数学公式小编整理的markdown相关文章码住,此处应该加鸡腿加
在MATLAB绘图中添加数学公式
目录参考第一种方法第二种方法第三种方法参考在Matlab绘图中添加数学公式(分式等) 如何在matlab的fig中显示tex公式第一种方法首先,选择插入->文本框,如下图所示以 ...
Typora添加数学公式
参考链接: https://blog.csdn.net/mingzhuo_126/article/details/82722455 https://www.cnblogs.com/144823836y ...
DOxygen for C++使用说明——注释代码二
这一次我在谷歌搜索中检索到了Doxygen在github的仓库,进去一看,令人大喜,github仓库里含有了一个Doxygen的官方配置文件Doxyfile,于是下载下来,发现Doxyfile已经配置 ...
C# 在PPT中添加数学公式
本次内容介绍在C#程序中给PPT幻灯片添加Latex数学公式,添加公式前,首先需要在幻灯片中插入一个Shape形状,在形状的段落中通过方法Paragraphs.AddParagraphFromLate ...
【Tools】CSDN中如何添加数学公式
对于更具体的所有用法,例如希腊字母等等各种符号,可以参考Cmd Markdown 公式指导手册 1.公式或者符号使用$包起来,前后各一个$包起来就是公式. 2.如果想要公式居中,就前后各用两个$包起来 ...
Doxygen for C++使用说明——注释代码一
写这一节的时候,我在想网上有众多的参考文献,外加官网上的,要是我再将它们重复一遍,也没什么意思.网上资料很多,但是他们有一个共同的缺点是都是罗列用法,然后显示效果.这些都是比较散的,我想是不是可以结合 ...

DOxygen for C++使用说明——添加数学公式

公式

Note:

效果：

参考文献：

DOxygen for C++使用说明——添加数学公式相关推荐

最新文章

热门文章