如何记录 C++ 非类型模板参数？答案

【问题标题】：How to document C++ non-type template parameters?如何记录 C++ 非类型模板参数？
【发布时间】：2020-02-23 20:10:36
【问题描述】：

是否有关于如何使用 Doxygen 记录 C++ 非类型模板参数的指南？

比如Test类中的非类型模板参数Size应该如何注释？

template<int Size>
class Test { };

我试过这样的声明：

/// \tparam Size

但它给出了以下警告：

"'\tparam' 命令在未附加到模板声明的注释中使用 [-Wdocumentation]".

【问题讨论】：

据我们所见，警告是正确的，因为评论似乎没有附加到模板上。请尝试创建minimal reproducible example 向我们展示，我们可以复制和复制您的问题。
除了 MWE 之外，您使用的是哪个版本的 doxygen，并且在 MWE 中还包括 doxygen 配置文件中与默认配置文件不同的设置。警告消息看起来也不像是来自 doxygen。

【解决方案1】：

我在我的代码中使用 JavaDoc 样式的 cmets。我用这个测试过：

/**
 * This is my test.
 *
 * @param Size Interesting
 */
template <int Size>
class Test {
};

它产生了这个：

Detailed Description

template<int Size>
class Test< Size >

This is my test.

Parameters
Size    Interesting

【讨论】：