doxygen的C++联模板文件

是否有某种方式来记录模板参数是这样的：doxygen的C++联模板文件

template< 
    int N, ///< description 
    typename T ///< description 
>

，而不是列出所有与tparam每个参数？

void function(int a /**< description */);

如果没有一个，如何努力将实现它：

请注意，函数参数可以在当前的doxygen进行记录这样吗？如果你熟悉doxygen的内部构件，你能指出我实现它的方向吗？

谢谢

来源

2010-05-30 Anycorn

没有办法像你描述的那样记录你的模板参数。

我会说这不是一个好主意，因为那样你会记录你的模板参数与通常的参数不同，你为什么要这样做？

通常它看起来是这样的：

/*! \p transpose : transpose a matrix 
* 
* \param A input matrix 
* \param At output matrix (transpose of A) 
* 
* \tparam MatrixType1 matrix 
* \tparam MatrixType2 matrix 
*/ 

template <typename MatrixType1, typename MatrixType2> 
void transpose(const MatrixType1& A, MatrixType2& At);

，你希望它看起来像这样？

/*! \p transpose : transpose a matrix 
* 
* \param A input matrix 
* \param At output matrix (transpose of A) 
* 
*/ 

template < 
    typename MatrixType1, ///< matrix 
    typename MatrixType2 ///< matrix 
> 
void transpose(const MatrixType1& A, MatrixType2& At);

为什么？

来源

2010-05-31 10:48:32 arturh

他* *可以*将每个常用参数放在一个新行中。 – Pieter 2010-05-31 10:58:31

是的，我也想放置这样的参数。我只是觉得读起来有点容易，因为在声明后立即记录参数 – Anycorn 2010-05-31 16:49:33

通过记录它们在代码中定义的参数，添加时忘记记录新参数的风险，或者忘记删除参数的文档时，它会显着减少。 – HelloGoodbye 2013-06-24 13:43:57

doxygen的C++联模板文件

回答

相关问题