以下是可以在文档中使用的所有 HTML 命令列表。请注意,尽管这些 HTML 标签会转换为 HTML 以外输出格式的适当命令,但 HTML 标签的所有属性只传递到 HTML 输出中(A
标签的 HREF
和 NAME
属性是唯一的例外)。
HTML 命令 | 描述 |
---|---|
<A HREF="..."> | 开始一个超链接(如果输出格式支持)。 |
<A ID="..."> | 开始一个命名锚点(如果输出格式支持)。 |
<A NAME="..."> | 开始一个命名锚点(如果输出格式支持)。 |
</A> | 结束链接或锚点 |
<B> / </B> | 开始和结束一段以粗体字体显示的文本。 |
<BLOCKQUOTE> / </BLOCKQUOTE> | 开始和结束一个引用块。 |
<BR> | 强制换行。 |
<CENTER> / </CENTER> | 开始和结束一段居中对齐的文本。 |
<CAPTION> / </CAPTION> | 开始和结束一个标题。仅在表格内使用。 |
<CITE> / </CITE> | 开始和结束一段以引文特定字体显示的文本。 |
<CODE> / </CODE> | 开始和结束一段以打字机字体显示的文本。请注意,仅对于 C# 代码,此命令等同于 \code (见 <code>)。 |
<DD> / </DD> | 开始和结束一个项目描述。 |
<DEL> / </DEL> | 开始和结束一段已删除的文本,通常显示为删除线文本。 |
<DETAILS> / </DETAILS> | 开始和结束一段用户可以打开和关闭的详细文本(在 HTML 输出中)。 |
<DFN> / </DFN> | 开始和结束一段以打字机字体显示的文本。 |
<DIV> / </DIV> | 开始和结束一个带有特定样式的部分(仅 HTML) |
<DL> / </DL> | 开始和结束一个描述列表。 |
<DT> / </DT> | 开始和结束一个项目标题。 |
<EM> / </EM> | 开始和结束一段以斜体字体显示的文本。 |
<HR> | 绘制一条水平线。 |
<H1> / </H1> | 开始和结束一个无编号部分。 |
<H2> / </H2> | 开始和结束一个无编号子部分。 |
<H3> / </H3> | 开始和结束一个无编号子子部分。 |
<H4> / </H4> | 开始和结束一个无编号子子部分。 |
<H5> / </H5> | 开始和结束一个无编号子子部分。 |
<H6> / </H6> | 开始和结束一个无编号子子部分。 |
<I> / </I> | 开始和结束一段以斜体字体显示的文本。 |
<IMG SRC="..." ...> | 此命令及其属性仅写入到 HTML 输出。SRC 属性是必需的。 |
<INS> / </INS> | 开始和结束一段插入的文本,通常显示为带下划线的文本。 |
<KBD> / </KBD> | 开始和结束一段以打字机字体显示的文本。 |
<LI> / </LI> | 开始和结束一个新的列表项。 |
<OL> / </OL> | 开始和结束一个有序列表。 |
<P> / </P> | 开始和结束一个新的段落。 |
<PRE> / </PRE> | 开始和结束一个预格式化片段。 |
<S> / </S> | 开始和结束一段删除线文本。 |
<SMALL> / </SMALL> | 开始和结束一段以较小字体显示的文本。 |
<SPAN> / </SPAN> | 开始和结束一个带有特定样式的内联文本片段(仅 HTML) |
<STRIKE> / </STRIKE> | 开始和结束一段删除线文本。 |
<STRONG> / </STRONG> | 开始和结束一段粗体文本。 |
<SUB> / </SUB> | 开始和结束一段以下标显示的文本。 |
<SUP> / </SUP> | 开始和结束一段以上标显示的文本。 |
<TABLE> / </TABLE> | 开始和结束一个表格。 |
<TBODY> / </TBODY> | 开始和结束一个新的表格主体,目前 Doxygen 会忽略。 |
<TD> / </TD> | 开始和结束一个新的表格数据元素。 |
<TH> / </TH> | 开始和结束一个新的表头。 |
<THEAD> / </THEAD> | 开始和结束一个新的表头,目前 Doxygen 会忽略。 |
<TFOOT> / </TFOOT> | 开始和结束一个新的表尾,目前 Doxygen 会忽略。 |
<TR> / </TR> | 开始和结束一个新的表格行。 |
<TT> / </TT> | 开始和结束一段以打字机字体显示的文本。 |
<U> / </U> | 开始和结束一段带下划线的文本。 |
<UL> / </UL> | 开始和结束一个无序列表。 |
<VAR> / </VAR> | 开始和结束一段以斜体字体显示的文本。 |
最后,我们有 HTML 风格的注释。
<!--! ... -->
时,它不会被视为注释,而是视为 ...
部分直接在文档中。这对于在 markdown 文件中指定 Doxygen 命令非常有用,例如/*! <!-- This is a comment with a comment block --> Visible text */<!-- ... --> 部分将不会显示在主文档中。
注意:明确禁止在闭合的大于号之前使用三个破折号。Doxygen 不会将其视为闭合,并会发出警告。
HTML4 特殊字符实体列表及其描述取自:HTML 4 中的字符实体引用。(部分 © 国际标准化组织 1986 允许以任何形式复制以用于符合 ISO 8879 中定义的 SGML 系统和应用程序,前提是所有副本中都包含此通知。)
实体 | 描述 | |
---|---|---|
| 不间断空格 = 非破坏性空格 | |
¡ | ¡ | 倒感叹号 |
¢ | ¢ | 分钱符号 |
£ | £ | 英镑符号 |
¤ | ¤ | 货币符号 |
¥ | ¥ | 日元符号 = 人民币符号 |
¦ | ¦ | 断线 = 断垂直线 |
§ | § | 章节符号 |
¨ | ¨ | 分音符 = 空格分音符 |
© | © | 版权符号 |
ª | ª | 阴性序数指示符 |
« | « | 左指向双角引号 = 左指向 guillemet |
¬ | ¬ | 非符号 |
­ | | 软连字符 = 可选连字符 |
® | ® | 注册符号 = 注册商标符号 |
¯ | ¯ | 长音符 = 空格长音符 = 上划线 = APL 上划线 |
° | ° | 度符号 |
± | ± | 正负号 |
² | ² | 上标二 = 上标数字二 = 平方 |
³ | ³ | 上标三 = 上标数字三 = 立方 |
´ | ´ | 尖音符 = 空格尖音符 |
µ | µ | 微符号 |
¶ | ¶ | 段落符号 |
· | · | 中点 = 格鲁吉亚逗号 = 希腊中点 |
¸ | ¸ | 软音符 = 空格软音符 |
¹ | ¹ | 上标一 = 上标数字一 |
º | º | 阳性序数指示符 |
» | » | 右指向双角引号 = 右指向 guillemet |
¼ | ¼ | 普通分数四分之一 = 分数四分之一 |
½ | ½ | 普通分数二分之一 = 分数二分之一 |
¾ | ¾ | 普通分数四分之三 = 分数四分之三 |
¿ | ¿ | 倒问号 |
À | À | 带重音符的拉丁大写字母 A = 拉丁大写字母 A grave |
Á | Á | 带尖音符的拉丁大写字母 A |
 |  | 带扬抑符的拉丁大写字母 A |
à | à | 带波浪符的拉丁大写字母 A |
Ä | Ä | 带分音符的拉丁大写字母 A |
Å | Å | 带上方圈的拉丁大写字母 A = 拉丁大写字母 A ring |
Æ | Æ | 拉丁大写字母 AE = 拉丁大写连字 AE |
Ç | Ç | 带软音符的拉丁大写字母 C |
È | È | 带重音符的拉丁大写字母 E |
É | É | 带尖音符的拉丁大写字母 E |
Ê | Ê | 带扬抑符的拉丁大写字母 E |
Ë | Ë | 带分音符的拉丁大写字母 E |
Ì | Ì | 带重音符的拉丁大写字母 I |
Í | Í | 带尖音符的拉丁大写字母 I |
Î | Î | 带扬抑符的拉丁大写字母 I |
Ï | Ï | 带分音符的拉丁大写字母 I |
Ð | Ð | 拉丁大写字母 ETH |
Ñ | Ñ | 带波浪符的拉丁大写字母 N |
Ò | Ò | 带重音符的拉丁大写字母 O |
Ó | Ó | 带尖音符的拉丁大写字母 O |
Ô | Ô | 带扬抑符的拉丁大写字母 O |
Õ | Õ | 带波浪符的拉丁大写字母 O |
Ö | Ö | 带分音符的拉丁大写字母 O |
× | × | 乘号 |
Ø | Ø | 带斜线的拉丁大写字母 O = 拉丁大写字母 O slash |
Ù | Ù | 带重音符的拉丁大写字母 U |
Ú | Ú | 带尖音符的拉丁大写字母 U |
Û | Û | 带扬抑符的拉丁大写字母 U |
Ü | Ü | 带分音符的拉丁大写字母 U |
Ý | Ý | 带尖音符的拉丁大写字母 Y |
Þ | Þ | 拉丁大写字母 THORN |
ß | ß | 拉丁小写字母 sharp s = ess-zed |
à | à | 带重音符的拉丁小写字母 a = 拉丁小写字母 a grave |
á | á | 带尖音符的拉丁小写字母 a |
â | â | 带扬抑符的拉丁小写字母 a |
ã | ã | 带波浪符的拉丁小写字母 a |
ä | ä | 带分音符的拉丁小写字母 a |
å | å | 带上方圈的拉丁小写字母 a = 拉丁小写字母 a ring |
æ | æ | 拉丁小写字母 ae = 拉丁小写连字 ae |
ç | ç | 带软音符的拉丁小写字母 c |
è | è | 带重音符的拉丁小写字母 e |
é | é | 带尖音符的拉丁小写字母 e |
ê | ê | 带扬抑符的拉丁小写字母 e |
ë | ë | 带分音符的拉丁小写字母 e |
ì | ì | 带重音符的拉丁小写字母 i |
í | í | 带尖音符的拉丁小写字母 i |
î | î | 带扬抑符的拉丁小写字母 i |
ï | ï | 带分音符的拉丁小写字母 i |
ð | ð | 拉丁小写字母 eth |
ñ | ñ | 带波浪符的拉丁小写字母 n |
ò | ò | 带重音符的拉丁小写字母 o |
ó | ó | 带尖音符的拉丁小写字母 o |
ô | ô | 带扬抑符的拉丁小写字母 o |
õ | õ | 带波浪符的拉丁小写字母 o |
ö | ö | 带分音符的拉丁小写字母 o |
÷ | ÷ | 除号 |
ø | ø | 带斜线的拉丁小写字母 o |
ù | ù | 带重音符的拉丁小写字母 u |
ú | ú | 带尖音符的拉丁小写字母 u |
û | û | 带扬抑符的拉丁小写字母 u |
ü | ü | 带分音符的拉丁小写字母 u |
ý | ý | 带尖音符的拉丁小写字母 y |
þ | þ | 拉丁小写字母 thorn |
ÿ | ÿ | 带分音符的拉丁小写字母 y |
ƒ | ƒ | 带钩的拉丁小写 f = 函数 = 弗罗林 |
Α | Α | 希腊大写字母 alpha |
Β | Β | 希腊大写字母 beta |
Γ | Γ | 希腊大写字母 gamma |
Δ | Δ | 希腊大写字母 delta |
Ε | Ε | 希腊大写字母 epsilon |
Ζ | Ζ | 希腊大写字母 zeta |
Η | Η | 希腊大写字母 eta |
Θ | Θ | 希腊大写字母 theta |
Ι | Ι | 希腊大写字母 iota |
Κ | Κ | 希腊大写字母 kappa |
Λ | Λ | 希腊大写字母 lambda |
Μ | Μ | 希腊大写字母 mu |
Ν | Ν | 希腊大写字母 nu |
Ξ | Ξ | 希腊大写字母 xi |
Ο | Ο | 希腊大写字母 omicron |
Π | Π | 希腊大写字母 pi |
Ρ | Ρ | 希腊大写字母 rho |
Σ | Σ | 希腊大写字母 sigma |
Τ | Τ | 希腊大写字母 tau |
Υ | Υ | 希腊大写字母 upsilon |
Φ | Φ | 希腊大写字母 phi |
Χ | Χ | 希腊大写字母 chi |
Ψ | Ψ | 希腊大写字母 psi |
Ω | Ω | 希腊大写字母 omega |
α | α | 希腊小写字母 alpha |
β | β | 希腊小写字母 beta |
γ | γ | 希腊小写字母 gamma |
δ | δ | 希腊小写字母 delta |
ε | ε | 希腊小写字母 epsilon |
ζ | ζ | 希腊小写字母 zeta |
η | η | 希腊小写字母 eta |
θ | θ | 希腊小写字母 theta |
ι | ι | 希腊小写字母 iota |
κ | κ | 希腊小写字母 kappa |
λ | λ | 希腊小写字母 lambda |
μ | μ | 希腊小写字母 mu |
ν | ν | 希腊小写字母 nu |
ξ | ξ | 希腊小写字母 xi |
ο | ο | 希腊小写字母 omicron |
π | π | 希腊小写字母 pi |
ρ | ρ | 希腊小写字母 rho |
ς | ς | 希腊小写字母 final sigma |
σ | σ | 希腊小写字母 sigma |
τ | τ | 希腊小写字母 tau |
υ | υ | 希腊小写字母 upsilon |
φ | φ | 希腊小写字母 phi |
χ | χ | 希腊小写字母 chi |
ψ | ψ | 希腊小写字母 psi |
ω | ω | 希腊小写字母 omega |
ϑ | ϑ | 希腊小写字母 theta 符号 |
ϒ | ϒ | 带钩希腊 upsilon 符号 |
ϖ | ϖ | 希腊 pi 符号 |
• | • | 项目符号 = 黑色小圆点 |
… | … | 水平省略号 = 三点前导符 |
′ | ′ | 撇号 = 分 = 英尺 |
″ | ″ | 双撇号 = 秒 = 英寸 |
‾ | ‾ | 上划线 = 空格上划线 |
⁄ | ⁄ | 分数斜线 |
℘ | ℘ | 手写体大写字母 P = 幂集 = Weierstrass p |
ℑ | ℑ | 黑体大写字母 I = 虚部 |
ℜ | ℜ | 黑体大写字母 R = 实部符号 |
™ | ™ | 商标符号 |
ℵ | ℵ | alef 符号 = 第一个超限基数 |
← | ← | 向左箭头 |
↑ | ↑ | 向上箭头 |
→ | → | 向右箭头 |
↓ | ↓ | 向下箭头 |
↔ | ↔ | 左右箭头 |
↵ | ↵ | 带拐角向左的向下箭头 = 回车符 |
⇐ | ⇐ | 向左双箭头 |
⇑ | ⇑ | 向上双箭头 |
⇒ | ⇒ | 向右双箭头 |
⇓ | ⇓ | 向下双箭头 |
⇔ | ⇔ | 左右双箭头 |
∀ | ∀ | 对于所有 |
∂ | ∂ | 偏微分 |
∃ | ∃ | 存在 |
∅ | ∅ | 空集 = null 集 = 直径 |
∇ | ∇ | nabla = 后向差分 |
∈ | ∈ | 元素属于 |
∉ | ∉ | 元素不属于 |
∋ | ∋ | 包含作为成员 |
∏ | ∏ | n 元积 = 乘积符号 |
∑ | ∑ | n 元求和 |
− | − | 减号 |
∗ | ∗ | 星号运算符 |
√ | √ | 平方根 = 根号 |
∝ | ∝ | 正比于 |
∞ | ∞ | 无穷 |
∠ | ∠ | 角 |
∧ | ∧ | 逻辑与 = wedge |
∨ | ∨ | 逻辑或 = vee |
∩ | ∩ | 交集 = cap |
∪ | ∪ | 并集 = cup |
∫ | ∫ | 积分 |
∴ | ∴ | 所以 |
∼ | ∼ | 波浪线运算符 = 随...变化 = 相似于 |
≅ | ≅ | 约等于 |
≈ | ≈ | 几乎等于 = 渐近于 |
≠ | ≠ | 不等于 |
≡ | ≡ | 恒等于 |
≤ | ≤ | 小于或等于 |
≥ | ≥ | 大于或等于 |
⊂ | ⊂ | 子集 |
⊃ | ⊃ | 超集 |
⊄ | ⊄ | 不是子集 |
⊆ | ⊆ | 子集或等于 |
⊇ | ⊇ | 超集或等于 |
⊕ | ⊕ | 带圈加号 = 直和 |
⊗ | ⊗ | 带圈乘号 = 向量积 |
⊥ | ⊥ | 向上点 = 正交于 = 垂直 |
⋅ | ⋅ | 点运算符 |
⌈ | ⌈ | 左上限 = apl upstile |
⌉ | ⌉ | 右上限 |
⌊ | ⌊ | 左下限 = apl downstile |
⌋ | ⌋ | 右下限 |
⟨ | ⟨ | 左指向角括号 = bra |
⟩ | ⟩ | 右指向角括号 = ket |
◊ | ◊ | 菱形 |
♠ | ♠ | 黑桃符号 |
♣ | ♣ | 梅花符号 = 三叶草 |
♥ | ♥ | 红桃符号 = 情人节 |
♦ | ♦ | 方块符号 |
" | " | 引号 = APL quote |
& | & | 和号 |
< | < | 小于号 |
> | > | 大于号 |
Œ | Œ | 拉丁大写连字 OE |
œ | œ | 拉丁小写连字 oe |
Š | Š | 带抑扬符的拉丁大写字母 S |
š | š | 带抑扬符的拉丁小写字母 s |
Ÿ | Ÿ | 带分音符的拉丁大写字母 Y |
ˆ | ˆ | 修饰符扬抑符 |
˜ | ˜ | 小波浪符 |
  | 半角空格 | |
  | 全角空格 | |
  | 窄空格 | |
‌ | | 零宽度非连接符 |
‍ | | 零宽度连接符 |
‎ | | 从左到右标记 |
‏ | | 从右到左标记 |
– | – | 短横线 |
— | — | 长横线 |
‘ | ‘ | 左单引号 |
’ | ’ | 右单引号 |
‚ | ‚ | 单低位 9 引号 |
“ | “ | 左双引号 |
” | ” | 右双引号 |
„ | „ | 双低位 9 引号 |
† | † | 匕首符号 |
‡ | ‡ | 双匕首符号 |
‰ | ‰ | 千分号 |
‹ | ‹ | 左指向单角引号 |
› | › | 右指向单角引号 |
€ | € | 欧元符号 |
Doxygen 扩展 | ||
&tm; | ™ | 商标符号 |
' | ' | 撇号 |