3 doxygen 公式

1 包括公式

Doxygen允许您和RTF输出。要在HTML和RTF文档中包含公式（作为图像），还需要安装以下工具

• latex:该编译器，需要解析公式。为了测试，我使用了teTeX 1.0发行版。
• dvips: 将DVI文件转换为PostScript文件的工具我已经使用了Radical Eye软件的5.92b版本进行测试。
• gs:GhostScript解释器，用于将PostScript文件转换为位图。我已使用Aladdin GhostScript 8.0进行测试。

对于HTML输出，还有一种使用MathJax的替代解决方案，不需要上述工具。如果在配置中启用USE_MATHJAX，则乳胶配方将“按原样”复制到HTML，并且客户端javascript将对其进行解析并将其转换为（交互式）图像。

在文档中包含公式的三种方法。

1. 使用出现在运行文本中的文本公式。这些公式应放在一对\ f $命令之间，因此

     \ f $（x_1，y_1）\ f $和\ f $（x_2，y_2）\ f $之间的距离为 
     \ f $ \ sqrt {（x_2-x_1）^ 2 +（y_2-y_1）^ 2} \ f $。
   

   结果是：

   之间的距离[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-IdVqHkwu-1583386988472)(http://www.doxygen.nl/manual/form_1.png)]和是。

2. 未编号的显示公式以单独的行为中心。这些公式应放在\ f [和\ f]命令之间。一个例子：

     \F[
       | I_2 | = \左| \ int_ {0} ^ T \ psi（t）
                \剩下\{ 
                   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]
   

   结果是：

   ![\ | I_2 | = \左| \ 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 | ]

3. 可以使用\ f {environment}来指定不在数学环境中的公式或其他乳胶元素，其中

   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}
   

   结果是：

   

对于前两个命令，应确保公式在数学模式下包含有效命令。对于第三条命令，该部分应包含针对特定环境的有效命令。

• 警告

  当前，从公式中的错别字恢复中，doxygen的容错性不是很高。可能有必要删除formula.repository写入html，rtf等目录的文件，以消除不正确的公式以及这些form_*文件。

为了可以定义自己的输出中（用于PDF生成）。
在\newcommand（和\renewcommand）被限制为不可选参数的版本，所以只支持以下类型：

\ newcommand {\ cmd} {替换}

​ 和

\ newcommand {\ cmd} [nr] {替换}

例如

\ newcommand {\ E} {\ mathrm {E}}

\ newcommand {\ ccSum} [3] {\ sum _ {＃1} ^ {＃2} {＃3}}

转到下一部分或返回 索引。