自定义命令

Doxygen 提供了大量的特殊命令XML 命令HTML 命令,可用于增强或构建注释块中的文档。如果由于某种原因需要定义新命令,可以通过别名定义来实现。

别名的定义应在配置文件中使用ALIASES配置标签指定。

简单别名

别名最简单的形式是以下形式的简单替换

 name=value

例如,定义以下别名

 ALIASES += sideeffect="\par Side Effects:^^"

将允许您在文档中放置命令\sideeffect(或@sideeffect),这将生成一个带有标题副作用:的用户定义段落。

请注意,您不能在别名的值部分放置\n以插入新行(在结果输出中)。您可以在别名的值部分放置^^以插入新行,就像原始文件中存在物理新行一样。

请注意,当您在别名的值部分需要文字{},(或非默认分隔符)时,您必须通过反斜杠(\\endiskip)对其进行转义,这可能导致与命令\{\}冲突,对于这些命令,建议使用@{@}版本或使用双重转义(\\{\\}

另请注意,如果您愿意,可以重新定义现有的特殊命令。

某些命令,例如\xrefitem,旨在与别名结合使用。

带参数的别名

别名也可以带有一个或多个参数。在别名定义中,您需要在大括号之间指定参数的数量。在定义的 值部分,您可以放置\x标记,其中“x”表示参数编号,从1开始。

这是一个带单个参数的别名定义的示例

ALIASES += l{1}="\ref \1"

在注释块中,您可以如下使用它

/** See \l{SomeClass} for more information. */

这与写作相同

/** See \ref SomeClass for more information. */

请注意,您可以使用带多个参数的版本来重载别名,例如

ALIASES += l{1}="\ref \1"
ALIASES += l{2}="\ref \1 \"\2\""

请注意,别名定义中的引号必须用反斜杠转义。

有了这些别名定义,我们可以写

/** See \l{SomeClass,Some Text} for more information. */

在注释块中,它将扩展为

/** See \ref SomeClass "Some Text" for more information. */

其中带单个参数的命令仍将如前所示工作。

别名也可以用其他别名来表达,例如,新命令\reminder可以通过中间的\xreflist命令表达为\xrefitem,如下所示

ALIASES += xreflist{3}="\xrefitem \1 \"\2\" \"\3\" "
ALIASES += reminder="\xreflist{reminders,Reminder,Reminders}"

请注意,对于带有多个参数的别名,如果使用逗号作为分隔符,如果要在命令中放置逗号,则需要用反斜杠对其进行转义,即

\l{SomeClass,Some text\, with an escaped comma}

给定上述示例中\l的别名定义。

默认情况下,别名中参数的分隔符是逗号。然而,对于带有大量逗号的参数,例如函数定义的模板,转义每个逗号可能很麻烦。为了解决这个问题,可以直接在参数计数之后指定不同的分隔符,例如,要使用分号作为分隔符,可以按如下方式定义命令

ALIASES += xreflist{3;}="\xrefitem \1 \"\2\" \"\3\" "
ALIASES += reminder="\xreflist{reminders;Reminder;Reminders}"

请注意,也允许使用多字符分隔符,即,可以使用双管道符号作为分隔符来编写相同的示例

ALIASES += xreflist{3||}="\xrefitem \1 \"\2\" \"\3\" "
ALIASES += reminder="\xreflist{reminders||Reminder||Reminders}"

允许使用以下字符创建分隔符

!#$%&,.?|;:'+=~`/

请注意,对于每个命令和参数数量,可以使用不同的分隔符。然而,不建议对相同的命令选择不同的分隔符,因为这可能导致要使用哪个命令定义存在歧义。Doxygen 通过选择与最多参数匹配的命令来解决这种歧义。考虑以下,相当做作的示例

ALIASES += v{2+}="Choose 2: '\1' and '\2'"
ALIASES += v{3;}="Choose 3: '\1', '\2', and '\3'"

然后

- \v{One+Two}
- \v{One;Two;Three}
- \v{One+Two;Three;Four}

将产生

  • 选择 2:“一”和“二”
  • 选择 3:“一”、“二”和“三”
  • 选择 3:“一+二”、“三”和“四”

对于最后一个命令,v的两个定义都匹配,但选择带有 3 个参数的定义,因为它匹配更多的参数。

嵌套自定义命令

您可以将命令用作别名的参数,包括使用别名定义的命令。

例如,考虑以下别名定义

ALIASES += Bold{1}="<b>\1</b>"
ALIASES += Emph{1}="<em>\1</em>"

在注释块中,您现在可以使用

/** This is a \Bold{bold \Emph{and} Emphasized} text fragment. */

它将扩展为

/** This is a <b>bold <em>and</em> Emphasized</b> text fragment. */


转到下一节或返回到索引