在 Doxygen 中引用模板参数的正确方法是什么?
What's the right way to reference a template parameters in Doxygen?
后续问题:
What's the right way to reference a parameter in Doxygen?
因此,对于参数,我们使用 @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
应该用什么代替?
@p
真的 "reference" 不是一个参数;它只是用打字机字体设置下一个单词的样式。您通常会使用它来引用参数,但是 @p
除了为下一个单词使用打字机字体之外没有做任何特别的事情。
因此,您可以根据需要使用 @p
设置模板参数的样式。或者您可以使用 @a
。或者是其他东西。这完全取决于您希望结果的显示方式。
要创建另一个符号的引用,请使用@ref 命令。但是,此命令不适用于参数。 Doxygen 没有将它们识别为 @ref.
的目标
后续问题:
What's the right way to reference a parameter in Doxygen?
因此,对于参数,我们使用 @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
应该用什么代替?
@p
真的 "reference" 不是一个参数;它只是用打字机字体设置下一个单词的样式。您通常会使用它来引用参数,但是 @p
除了为下一个单词使用打字机字体之外没有做任何特别的事情。
因此,您可以根据需要使用 @p
设置模板参数的样式。或者您可以使用 @a
。或者是其他东西。这完全取决于您希望结果的显示方式。
要创建另一个符号的引用,请使用@ref 命令。但是,此命令不适用于参数。 Doxygen 没有将它们识别为 @ref.
的目标