在 Doxygen 中引用模板参数的正确方法是什么？答案

【问题标题】：What's the right way to reference a template parameters in Doxygen?在 Doxygen 中引用模板参数的正确方法是什么？
【发布时间】：2016-12-01 14:42:15
【问题描述】：

一个后续问题：

所以，对于参数，我们使用@param

@param my_param the quick brown fox takes this parameter over the lazy dog

然后我们可以使用@p引用它：

@param my_other_param this is completely different from @p my_param , you know!

现在，对于模板参数，我会将@param 替换为@tparam。应该用什么替换@p？

【问题讨论】：

【解决方案1】：

@p 并没有真的“引用”一个参数；它只是用打字机字体设计下一个单词。您通常会使用它来引用参数，但@p 除了使用打字机字体作为下一个单词之外并没有做任何特别的事情。

因此，您可以根据需要使用@p 设置模板参数的样式。或者你可以使用@a。或者是其他东西。这完全取决于您希望结果的外观。

【讨论】：

【解决方案2】：

要创建另一个符号的引用，请使用@ref 命令。但是，此命令不适用于参数。 Doxygen 不会将它们识别为@ref 的目标。

【讨论】：