带有占位符的 Doxygen 自定义标签答案

【问题标题】：Doxygen custom tag with a placeholder带有占位符的 Doxygen 自定义标签
【发布时间】：2019-02-14 12:25:17
【问题描述】：

在 Doxygen 中是否有可能创建一个自定义标签，该标签使用占位符标签作为其输入来创建文档？

我想要完成的是为需求创建一个自定义标签。由于我们的 DOORS Url 很长，并且从 SW 组件到 SW 组件不同，我想创建类似这样的东西：

@file somefile.c
@doorsdocurl <URL to DOORS document> -> this is going to be my placeholder

...
...
...


/**
* @brief somedescription
* @req{doorsdocurl: <reqID1, reqID2,...> } -> this is going to be the second custom tag
*/
void jambo()
{
}

这是否可以通过 Doxygen 以某种方式实现？根据我的阅读，必须将他的自定义标签放在 ALIASES 变量中

【问题讨论】：

当我理解正确时，您希望在文件中设置 URL 并在本文档中进一步使用它。根据 SW 组件的数量（以及 URL 更改的速率），我将为每个 SW 组件定义一个别名，例如 doorsdocurl_sw_1=....，在 \req 中，我将使用相关的别名，例如 \doorsdocurl_sw_1。确实可行还是我误解了什么？
嗨@albert。你理解我的正确：）你能给我一个完整的例子吗？

标签： c doxygen requirements

【解决方案1】：

在您的 Doxyfile 中，您需要以下内容：

ALIASES = "doorsdocurl_sw_1=<URL to DOORS document>" \
          "req{2}=\1 \2<br>"

代码如下：

/**
* @brief somedescription
*
* @req{@doorsdocurl_sw_1,reqID1}
* @req{@doorsdocurl_sw_1,reqID2}
*/
void jambo()
{
}

\req 命令当然可以用其他命令扩展，在这方面命令xrefitem 可能有用，请参阅手册 (http://www.doxygen.nl/manual/commands.html#cmdxrefitem)

【讨论】：

太好了。是否也可以以某种方式链接 req.身份证？ @req{@doorsdocurl_sw_1,reqID1,reqID2,..}
是的，您可以定义多个req 别名，例如ref{2}=...、req{3}=...，您可以在其中处理不同数量的参数。