这里列出了所有可以在文档中使用的 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 */
<!-- ... -->
部分不会显示在主文档中。注意:明确禁止在结束大于号之前使用 3 个破折号。Doxygen 也不会将其视为结束,并会发出警告。
特殊 HTML4 字符实体及其描述的列表取自:HTML 4 中的字符实体引用。(部分内容 © 国际标准化组织 1986 允许在符合 ISO 8879 中定义的 SGML 系统和应用程序的情况下以任何形式复制,前提是在所有副本中都包含此声明。)
实体 | 描述 | |
---|---|---|
| 不换行空格 = 不间断空格 | |
¡ | ¡ | 倒感叹号 |
¢ | ¢ | 分符号 |
£ | £ | 英镑符号 |
¤ | ¤ | 货币符号 |
¥ | ¥ | 日元符号 = 元符号 |
¦ | ¦ | 断裂竖线 = 断裂的垂直线 |
§ | § | 章节符号 |
¨ | ¨ | 分音符号 = 间距分音符 |
© | © | 版权符号 |
ª | ª | 女性序数指示符 |
« | « | 左指双角引号 = 左指 Guillemet 符号 |
¬ | ¬ | 非符号 |
­ | | 软连字符 = 可选连字符 |
® | ® | 注册符号 = 注册商标符号 |
¯ | ¯ | 长音符号 = 间距长音符号 = 上划线 = APL 上划线 |
° | ° | 度数符号 |
± | ± | 加减号 = 正负号 |
² | ² | 上标 2 = 上标数字 2 = 平方 |
³ | ³ | 上标 3 = 上标数字 3 = 立方 |
´ | ´ | 锐音符 = 间距锐音符 |
µ | µ | 微符号 |
¶ | ¶ | 段落符号 = 段落标志 |
· | · | 中点 = 格鲁吉亚逗号 = 希腊中点 |
¸ | ¸ | 软音符 = 间距软音符 |
¹ | ¹ | 上标 1 = 上标数字 1 |
º | º | 男性序数指示符 |
» | » | 右指双角引号 = 右指 Guillemet 符号 |
¼ | ¼ | 普通分数四分之一 = 分数四分之一 |
½ | ½ | 普通分数二分之一 = 分数二分之一 |
¾ | ¾ | 普通分数四分之三 = 分数四分之三 |
¿ | ¿ | 倒问号 = 反转问号 |
À | À | 带重音符的拉丁大写字母 A = 带重音符的拉丁大写字母 A |
Á | Á | 带锐音符的拉丁大写字母 A |
 |  | 带抑扬符的拉丁大写字母 A |
à | à | 带波浪号的拉丁大写字母 A |
Ä | Ä | 带分音符的拉丁大写字母 A |
Å | Å | 带上环的拉丁大写字母 A = 带环的拉丁大写字母 A |
Æ | Æ | 拉丁大写字母 AE = 拉丁大写连字 AE |
Ç | Ç | 带软音符的拉丁大写字母 C |
È | È | 带重音符的拉丁大写字母 E |
É | É | 带锐音符的拉丁大写字母 E |
Ê | Ê | 带抑扬符的拉丁大写字母 E |
Ë | Ë | 带分音符的拉丁大写字母 E |
Ì | Ì | 带重音符的拉丁大写字母 I |
Í | Í | 带锐音符的拉丁大写字母 I |
Î | Î | 带抑扬符的拉丁大写字母 I |
Ï | Ï | 带分音符的拉丁大写字母 I |
Ð | Ð | 拉丁大写字母 ETH |
Ñ | Ñ | 带波浪号的拉丁大写字母 N |
Ò | Ò | 带重音符的拉丁大写字母 O |
Ó | Ó | 带锐音符的拉丁大写字母 O |
Ô | Ô | 带抑扬符的拉丁大写字母 O |
Õ | Õ | 带波浪号的拉丁大写字母 O |
Ö | Ö | 带分音符的拉丁大写字母 O |
× | × | 乘法符号 |
Ø | Ø | 带斜杠的拉丁大写字母 O = 带斜线的拉丁大写字母 O |
Ù | Ù | 带重音符的拉丁大写字母 U |
Ú | Ú | 带锐音符的拉丁大写字母 U |
Û | Û | 带抑扬符的拉丁大写字母 U |
Ü | Ü | 带分音符的拉丁大写字母 U |
Ý | Ý | 带锐音符的拉丁大写字母 Y |
Þ | Þ | 拉丁大写字母 THORN |
ß | ß | 拉丁小写字母 sharp s = ess-zed |
à | à | 带重音符的拉丁小写字母 a = 带重音符的拉丁小写字母 a |
á | á | 带锐音符的拉丁小写字母 a |
â | â | 带抑扬符的拉丁小写字母 a |
ã | ã | 带波浪号的拉丁小写字母 a |
ä | ä | 带分音符的拉丁小写字母 a |
å | å | 带上环的拉丁小写字母 a = 带环的拉丁小写字母 a |
æ | æ | 拉丁小写字母 ae = 拉丁小写连字 ae |
ç | ç | 带软音符的拉丁小写字母 c |
è | è | 带重音符的拉丁小写字母 e |
é | é | 带锐音符的拉丁小写字母 e |
ê | ê | 带抑扬符的拉丁小写字母 e |
ë | ë | 带分音符的拉丁小写字母 e |
ì | ì | 带重音符的拉丁小写字母 i |
í | í | 带锐音符的拉丁小写字母 i |
î | î | 带抑扬符的拉丁小写字母 i |
ï | ï | 带分音符的拉丁小写字母 i |
ð | ð | 拉丁小写字母 eth |
ñ | ñ | 带波浪号的拉丁小写字母 n |
ò | ò | 带重音符的拉丁小写字母 o |
ó | ó | 带锐音符的拉丁小写字母 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 = 幂集 = 魏尔斯特拉斯 p |
ℑ | ℑ | 黑体大写 I = 虚部 |
ℜ | ℜ | 黑体大写 R = 实部符号 |
™ | ™ | 商标符号 |
ℵ | ℵ | 阿列夫符号 = 第一个超限基数 |
← | ← | 向左箭头 |
↑ | ↑ | 向上箭头 |
→ | → | 向右箭头 |
↓ | ↓ | 向下箭头 |
↔ | ↔ | 左右箭头 |
↵ | ↵ | 带左转角的向下箭头 = 回车符 |
⇐ | ⇐ | 向左双箭头 |
⇑ | ⇑ | 向上双箭头 |
⇒ | ⇒ | 向右双箭头 |
⇓ | ⇓ | 向下双箭头 |
⇔ | ⇔ | 左右双箭头 |
∀ | ∀ | 对所有 |
∂ | ∂ | 偏微分 |
∃ | ∃ | 存在 |
∅ | ∅ | 空集 = 零集 = 直径 |
∇ | ∇ | 纳布拉 = 向后差分 |
∈ | ∈ | 属于 |
∉ | ∉ | 不属于 |
∋ | ∋ | 包含为成员 |
∏ | ∏ | n元积 = 乘积符号 |
∑ | ∑ | n元求和 |
− | − | 减号 |
∗ | ∗ | 星号运算符 |
√ | √ | 平方根 = 根号 |
∝ | ∝ | 正比于 |
∞ | ∞ | 无穷大 |
∠ | ∠ | 角 |
∧ | ∧ | 逻辑与 = 合取 |
∨ | ∨ | 逻辑或 = 析取 |
∩ | ∩ | 交集 = 帽 |
∪ | ∪ | 并集 = 杯 |
∫ | ∫ | 积分 |
∴ | ∴ | 因此 |
∼ | ∼ | 波浪线运算符 = 随之变化 = 类似于 |
≅ | ≅ | 约等于 |
≈ | ≈ | 几乎等于 = 渐近于 |
≠ | ≠ | 不等于 |
≡ | ≡ | 恒等于 |
≤ | ≤ | 小于或等于 |
≥ | ≥ | 大于或等于 |
⊂ | ⊂ | 子集 |
⊃ | ⊃ | 超集 |
⊄ | ⊄ | 不是子集 |
⊆ | ⊆ | 子集或等于 |
⊇ | ⊇ | 超集或等于 |
⊕ | ⊕ | 带圆圈的加号 = 直和 |
⊗ | ⊗ | 带圆圈的乘号 = 向量积 |
⊥ | ⊥ | 上钉 = 正交于 = 垂直 |
⋅ | ⋅ | 点运算符 |
⌈ | ⌈ | 左上限 = apl 上竖线 |
⌉ | ⌉ | 右上限 |
⌊ | ⌊ | 左下限 = apl 下竖线 |
⌋ | ⌋ | 右下限 |
⟨ | ⟨ | 左尖括号 = bra |
⟩ | ⟩ | 右尖括号 = ket |
◊ | ◊ | 菱形 |
♠ | ♠ | 黑色黑桃花色 |
♣ | ♣ | 黑色梅花花色 = 三叶草 |
♥ | ♥ | 黑色红心花色 = 情人节 |
♦ | ♦ | 黑色方块花色 |
" | " | 引号 = APL 引号 |
& | & | 和号 |
< | < | 小于号 |
> | > | 大于号 |
Œ | Œ | 拉丁大写连字 OE |
œ | œ | 拉丁小写连字 oe |
Š | Š | 带抑扬符的拉丁大写字母 S |
š | š | 带抑扬符的拉丁小写字母 s |
Ÿ | Ÿ | 带分音符的拉丁大写字母 Y |
ˆ | ˆ | 修饰字母扬抑符 |
˜ | ˜ | 小波浪号 |
  | en 空格 | |
  | em 空格 | |
  | 细空格 | |
‌ | | 零宽度非连接符 |
‍ | | 零宽度连接符 |
‎ | | 从左到右标记 |
‏ | | 从右到左标记 |
– | – | 短破折号 |
— | — | 长破折号 |
‘ | ‘ | 左单引号 |
’ | ’ | 右单引号 |
‚ | ‚ | 单低九引号 |
“ | “ | 左双引号 |
” | ” | 右双引号 |
„ | „ | 双低九引号 |
† | † | 剑号 |
‡ | ‡ | 双剑号 |
‰ | ‰ | 千分号 |
‹ | ‹ | 单左尖引号 |
› | › | 单右尖引号 |
€ | € | 欧元符号 |
Doxygen 扩展 | ||
&tm; | ™ | 商标符号 |
' | ' | 撇号 |