HTML 指令

HTML 標籤指令

這裡是所有可在文件中使用的 HTML 指令列表。請注意,雖然這些 HTML 標籤會被轉換成其他 HTML 以外的輸出格式的適當指令,但 HTML 標籤的所有屬性只會傳遞到 HTML 輸出(A 標籤的 HREFNAME 屬性是唯一的例外)。

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 樣式的註解。

  • 當使用 Doxygen 特殊的 HTML 樣式註解時,例如 <!--! ... -->,它不會被視為註解,而是將 ... 部分視為在文件中。這對於在 Markdown 檔案中指定 Doxygen 指令很有用,例如
    <!--! \page pg1 The page -->
    這將被常規的 Markdown 處理器忽略,但 Doxygen 會將其解釋為如同寫了
    \page pg1 The page
  • 若要在註解區塊內放入不可見的註解,可以使用標準的 HTML 樣式註解
      /*! <!-- This is a comment with a comment block --> Visible text */
    
    <!-- ... --> 部分不會顯示在主要文件中。

注意:明確禁止在結束大於符號之前使用 3 個破折號。Doxygen 也不會將其視為結束符號,並會發出警告。

HTML4 字元實體

特殊 HTML4 字元實體的列表及其描述取自:HTML 4 中的字元實體參照。(部分 © International Organization for Standardization 1986。在 ISO 8879 中定義的,符合標準的 SGML 系統和應用程式中,允許以任何形式複製,前提是在所有副本中都包含此通知。)

實體  描述
&nbsp;   不換行空格 = non-breaking space
&iexcl; ¡倒反驚嘆號
&cent; ¢分符號
&pound; £英鎊符號
&curren; ¤貨幣符號
&yen; ¥日圓符號 = 人民幣符號
&brvbar; ¦斷裂線 = 斷裂垂直線
&sect; §段落符號
&uml; ¨分音符 = 間隔分音符
&copy; ©版權符號
&ordf; ª陰性序數指示符
&laquo; «左指雙角引號 = 左指角引號
&not; ¬非符號
&shy; ­軟連字號 = 選擇性連字號
&reg; ®註冊符號 = 註冊商標符號
&macr; ¯長音符號 = 間隔長音符號 = 上橫線 = APL 上橫線
&deg; °度符號
&plusmn; ±正負號
&sup2; ²上標二 = 上標數字二 = 平方
&sup3; ³上標三 = 上標數字三 = 立方
&acute; ´尖音符 = 間隔尖音符
&micro; µ微符號
&para; 段落符號
&middot; ·中間點 = 喬治亞逗號 = 希臘中間點
&cedil; ¸軟音符 = 間隔軟音符
&sup1; ¹上標一 = 上標數字一
&ordm; º陽性序數指示符
&raquo; »右指雙角引號 = 右指角引號
&frac14; ¼普通分數四分之一
&frac12; ½普通分數二分之一
&frac34; ¾普通分數四分之三
&iquest; ¿倒反問號
&Agrave; À帶重音符號的大寫拉丁字母 A
&Aacute; Á帶銳音符號的大寫拉丁字母 A
&Acirc; Â帶揚抑符號的大寫拉丁字母 A
&Atilde; Ã帶波浪符號的大寫拉丁字母 A
&Auml; Ä帶分音符號的大寫拉丁字母 A
&Aring; Å帶上圓圈的大寫拉丁字母 A
&AElig; Æ大寫拉丁字母 AE
&Ccedil; Ç帶軟音符號的大寫拉丁字母 C
&Egrave; È帶重音符號的大寫拉丁字母 E
&Eacute; É帶銳音符號的大寫拉丁字母 E
&Ecirc; Ê帶揚抑符號的大寫拉丁字母 E
&Euml; Ë帶分音符號的大寫拉丁字母 E
&Igrave; Ì帶重音符號的大寫拉丁字母 I
&Iacute; Í帶銳音符號的大寫拉丁字母 I
&Icirc; Î帶揚抑符號的大寫拉丁字母 I
&Iuml; Ï帶分音符號的大寫拉丁字母 I
&ETH; Ð大寫拉丁字母 ETH
&Ntilde; Ñ帶波浪符號的大寫拉丁字母 N
&Ograve; Ò帶重音符號的大寫拉丁字母 O
&Oacute; Ó帶銳音符號的大寫拉丁字母 O
&Ocirc; Ô帶揚抑符號的大寫拉丁字母 O
&Otilde; Õ帶波浪符號的大寫拉丁字母 O
&Ouml; Ö帶分音符號的大寫拉丁字母 O
&times; ×乘法符號
&Oslash; Ø帶斜線的大寫拉丁字母 O
&Ugrave; Ù帶重音符號的大寫拉丁字母 U
&Uacute; Ú帶銳音符號的大寫拉丁字母 U
&Ucirc; Û帶揚抑符號的大寫拉丁字母 U
&Uuml; Ü帶分音符號的大寫拉丁字母 U
&Yacute; Ý帶銳音符號的大寫拉丁字母 Y
&THORN; Þ大寫拉丁字母 THORN
&szlig; ß小寫拉丁字母 sharp s
&agrave; à帶重音符號的小寫拉丁字母 a
&aacute; á帶銳音符號的小寫拉丁字母 a
&acirc; â帶揚抑符號的小寫拉丁字母 a
&atilde; ã帶波浪符號的小寫拉丁字母 a
&auml; ä帶分音符號的小寫拉丁字母 a
&aring; å帶上圓圈的小寫拉丁字母 a
&aelig; æ小寫拉丁字母 ae
&ccedil; ç帶軟音符號的小寫拉丁字母 c
&egrave; è帶重音符號的小寫拉丁字母 e
&eacute; é帶銳音符號的小寫拉丁字母 e
&ecirc; ê帶揚抑符號的小寫拉丁字母 e
&euml; ë帶分音符號的小寫拉丁字母 e
&igrave; ì帶重音符號的小寫拉丁字母 i
&iacute; í帶銳音符號的小寫拉丁字母 i
&icirc; î帶揚抑符號的小寫拉丁字母 i
&iuml; ï帶分音符號的小寫拉丁字母 i
&eth; ð小寫拉丁字母 eth
&ntilde; ñ帶波浪符號的小寫拉丁字母 n
&ograve; ò帶重音符號的小寫拉丁字母 o
&oacute; ó帶銳音符號的小寫拉丁字母 o
&ocirc; ô帶揚抑符號的小寫拉丁字母 o
&otilde; õ帶波浪符號的小寫拉丁字母 o
&ouml; ö帶分音符號的小寫拉丁字母 o
&divide; ÷除法符號
&oslash; ø帶斜線的小寫拉丁字母 o
&ugrave; ù帶重音符號的小寫拉丁字母 u
&uacute; ú帶銳音符號的小寫拉丁字母 u
&ucirc; û帶揚抑符號的小寫拉丁字母 u
&uuml; ü帶分音符號的小寫拉丁字母 u
&yacute; ý帶銳音符號的小寫拉丁字母 y
&thorn; þ小寫拉丁字母 thorn
&yuml; ÿ帶分音符號的小寫拉丁字母 y
&fnof; ƒ帶鉤的小寫拉丁字母 f
&Alpha; Α希臘大寫字母 Alpha
&Beta; Β希臘大寫字母 Beta
&Gamma; Γ希臘大寫字母 Gamma
&Delta; Δ希臘大寫字母 Delta
&Epsilon; Ε希臘大寫字母 Epsilon
&Zeta; Ζ希臘大寫字母 Zeta
&Eta; Η希臘大寫字母 Eta
&Theta; Θ希臘大寫字母 Theta
&Iota; Ι希臘大寫字母 Iota
&Kappa; Κ希臘大寫字母 Kappa
&Lambda; Λ希臘大寫字母 Lambda
&Mu; Μ希臘大寫字母 Mu
&Nu; Ν希臘大寫字母 Nu
&Xi; Ξ希臘大寫字母 Xi
&Omicron; Ο希臘大寫字母 Omicron
&Pi; Π希臘大寫字母 Pi
&Rho; Ρ希臘大寫字母 Rho
&Sigma; Σ希臘大寫字母 Sigma
&Tau; Τ希臘大寫字母 Tau
&Upsilon; Υ希臘大寫字母 Upsilon
&Phi; Φ希臘大寫字母 Phi
&Chi; Χ希臘大寫字母 Chi
&Psi; Ψ希臘大寫字母 Psi
&Omega; Ω希臘大寫字母 Omega
&alpha; α希臘小寫字母 alpha
&beta; β希臘小寫字母 beta
&gamma; γ希臘小寫字母 gamma
&delta; δ希臘小寫字母 delta
&epsilon; ε希臘小寫字母 epsilon
&zeta; ζ希臘小寫字母 zeta
&eta; η希臘小寫字母 eta
&theta; θ希臘小寫字母 theta
&iota; ι希臘小寫字母 iota
&kappa; κ希臘小寫字母 kappa
&lambda; λ希臘小寫字母 lambda
&mu; μ希臘小寫字母 mu
&nu; ν希臘小寫字母 nu
&xi; ξ希臘小寫字母 xi
&omicron; ο希臘小寫字母 omicron
&pi; π希臘小寫字母 pi
&rho; ρ希臘小寫字母 rho
&sigmaf; ς希臘小寫字母 final sigma
&sigma; σ希臘小寫字母 sigma
&tau; τ希臘小寫字母 tau
&upsilon; υ希臘小寫字母 upsilon
&phi; φ希臘小寫字母 phi
&chi; χ希臘小寫字母 chi
&psi; ψ希臘小寫字母 psi
&omega; ω希臘小寫字母 omega
&thetasym; ϑ希臘小寫字母 theta 符號
&upsih; ϒ帶鉤的希臘 upsilon 符號
&piv; ϖ希臘 pi 符號
&bull; 項目符號 = 黑色小圓
&hellip; 水平省略號 = 三點引導符
&prime; 單引號 = 分鐘 = 英尺
&Prime; 雙引號 = 秒 = 英吋
&oline; 上橫線 = 間隔上標
&frasl; 分數斜線
&weierp; 草寫大寫 P = 冪集 = Weierstrass p
&image; 黑體大寫 I = 虛部
&real; 黑體大寫 R = 實部符號
&trade; 商標符號
&alefsym; aleph 符號 = 第一個超限基數
&larr; 向左箭頭
&uarr; 向上箭頭
&rarr; 向右箭頭
&darr; 向下箭頭
&harr; 左右箭頭
&crarr; 帶轉角的向下箭頭 = 回車符
&lArr; 向左雙箭頭
&uArr; 向上雙箭頭
&rArr; 向右雙箭頭
&dArr; 向下雙箭頭
&hArr; 左右雙箭頭
&forall; 對於所有
&part; 偏微分
&exist; 存在
&empty; 空集 = 零集 = 直徑
&nabla; nabla = 反向差分
&isin; 屬於
&notin; 不屬於
&ni; 包含作為成員
&prod; n 元積 = 乘積符號
&sum; n 元總和
&minus; 減號
&lowast; 星號運算子
&radic; 平方根 = 根號
&prop; 正比於
&infin; 無限
&ang;
&and; 邏輯與 = 楔形
&or; 邏輯或 = v 形
&cap; 交集 = 帽形
&cup; 聯集 = 杯形
&int; 積分
&there4; 因此
&sim; 波浪運算子 = 隨...變化 = 相似於
&cong; 約等於
&asymp; 幾乎等於 = 漸近於
&ne; 不等於
&equiv; 恆等於
&le; 小於或等於
&ge; 大於或等於
&sub; 子集於
&sup; 超集於
&nsub; 不是子集於
&sube; 子集於或等於
&supe; 超集於或等於
&oplus; 帶圓圈的加號 = 直和
&otimes; 帶圓圈的乘號 = 向量積
&perp; 上丁字 = 正交於 = 垂直
&sdot; 點運算子
&lceil; 左頂括號 = apl 上擋板
&rceil; 右頂括號
&lfloor; 左底括號 = apl 下擋板
&rfloor; 右底括號
&lang; 左指角括號 = bra
&rang; 右指角括號 = ket
&loz; 菱形
&spades; 黑桃花色
&clubs; 黑梅花花色 = 三葉草
&hearts; 黑愛心花色 = 情人節
&diams; 黑方塊花色
&quot; " 引號 = APL 引號
&amp; & 連字號
&lt; < 小於號
&gt; > 大於號
&OElig; Œ拉丁大寫連字 OE
&oelig; œ拉丁小寫連字 oe
&Scaron; Š帶抑揚符號的拉丁大寫字母 S
&scaron; š帶抑揚符號的拉丁小寫字母 s
&Yuml; Ÿ帶分音符號的拉丁大寫字母 Y
&circ; ˆ修飾字母抑揚符號
&tilde; ˜小波浪符號
&ensp; 半形空格
&emsp; 全形空格
&thinsp; 窄空格
&zwnj; 零寬度不連接符
&zwj; 零寬度連接符
&lrm; 由左至右符號
&rlm; 由右至左符號
&ndash; 短破折號
&mdash; 長破折號
&lsquo; 左單引號
&rsquo; 右單引號
&sbquo; 單低 9 引號
&ldquo; 左雙引號
&rdquo; 右雙引號
&bdquo; 雙低 9 引號
&dagger; 劍號
&Dagger; 雙劍號
&permil; 千分比符號
&lsaquo; 單左指角引號
&rsaquo; 單右指角引號
&euro; 歐元符號
Doxygen 擴充功能
&tm; 商標符號
&apos; ' 撇號


前往下一節,或返回索引