如何记录C++;非类型模板参数? 有没有关于如何用DoXGEY?< /P>记录C++非类型模板参数的指南?
例如,我们应该如何注释如何记录C++;非类型模板参数? 有没有关于如何用DoXGEY?< /P>记录C++非类型模板参数的指南?,c++,templates,doxygen,C++,Templates,Doxygen,例如,我们应该如何注释Test类中的非类型模板参数Size 模板 类测试{}; 我试过这样的声明: //\t内存大小 但它给出了以下警告: “'\tparam'命令用于未附加到模板声明[-Wdocumentation]的注释。” 我在代码中使用JavaDoc风格的注释。我用这个测试: /** * This is my test. * * @param Size Interesting */ template <int Size> class Test { }; /**
Test
类中的非类型模板参数Size
模板
类测试{};
我试过这样的声明:
//\t内存大小
但它给出了以下警告:
“'\tparam'命令用于未附加到模板声明[-Wdocumentation]的注释。”
我在代码中使用JavaDoc风格的注释。我用这个测试:
/**
* This is my test.
*
* @param Size Interesting
*/
template <int Size>
class Test {
};
/**
*这是我的测试。
*
*@param Size有趣
*/
模板
课堂测试{
};
它产生了这样的结果:
Detailed Description
template<int Size>
class Test< Size >
This is my test.
Parameters
Size Interesting
详细说明
模板
班级考试
这是我的测试。
参数
大小有趣
就我们所见,警告是正确的,因为注释似乎没有附加到模板上。请尝试创建一个向我们展示的,我们可以复制和复制您的问题。除了MWE,您使用的是哪个版本的doxygen,并且在MWE中包括与默认配置文件不同的doxygen配置文件中的设置。警告消息看起来也不像来自doxygen。为什么使用@param
而不是@tparam
。你用的是哪种强力剂?@albert啊,我从来没用过tparam。我的氧指数是1.8.14。我用tparam试过,结果只有轻微的差别。它说的是模板参数而不是参数。我不使用///风格的注释,所以它处理这个问题的方式可能有些奇怪。我认为这并不奇怪,Size
是一个模板参数,不是吗?