doxygen教程-8-插入公式

插入公式

渲染公式

doxygen 支持 latex 公式. 有两种途径渲染公式, 第一种是先把公式转化成图片, 然后在网页中显示图片, 这要求安装 latex 编译器, dvips, 和 GhostScript. 第二种是在配置文件中设置USE_MATHJAX = YES , 于是公式文本会被原样复制到 HTML 中, 并由客户端的 JavaScript 渲染公式.

编写公式

有以下几种插入公式的方法(不全):

1. 行内公式, 嵌入在普通文字中. 使用 \f$ 或 \f( 和 \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 $(x_1,y_1)$ and $(x_2,y_2)$ is $\sqrt{(x_2-x_1{)}^2+(y_2-y_1{)}^2}$.

2. 行间公式, 独占一行, 居中显示. 用 \f[ 和 \f] 包裹公式代码. 例如

   \f[
   	a^2 + b^2 = c^2
   \f]
   

   结果是:
   $$a^2+b^2=c^2$$

关于 latex 公式的语法, 请参考其他资料, 例如 markdown中公式编辑教程