2010-05-30 25 views
10

böyle şablon parametrelerini belgelemek için bir yol var mı:doxygen C++ satır içi şablon belgeler

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

yerine tparam ile her parametreyi listeleme daha? biri yoksa

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

, ne kadar zor bunu uygulamaya olacaktır:

o fonksiyon argümanları lütfen unutmayın cari doxygen böyle belgelenen edilebilir? Eğer doxygen içersine aşina iseniz, beni nereye uygulayacağınıza yönlendirin.

Eğer anlatılan gibi şablon parametrelerini belgelemek için bir yolu yoktur sizi

cevap

6

teşekkür ederim.

Bunun iyi bir fikir olmadığını söyleyebilirim, çünkü şablon parametrelerinizi normal parametrelerinizden farklı bir şekilde belgeleyecektiniz ve neden bunu istiyorsunuz?

/*! \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); 

ve böyle bakmak istiyorum ?!:

Genellikle şuna benzer

/*! \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); 

Neden?

+2

Her bir olağan parametreyi de yeni bir satıra * yerleştirebilir. – Pieter

+0

evet, bunun gibi parametreleri de yerleştirmek istedim. – Anycorn

+2

Bildirimi tamamlandıktan sonra parametre belgelendiğinden, (kaynakta) daha kolay okunur (kaynak olarak), çünkü kodda tanımlandıkları parametreleri belgeleyerek, eklendiğinde yeni bir parametrenin unutulma riskini veya kaldırıldığında bir parametrenin belgelerini kaldırmayı unutmak, önemli ölçüde azalır. – HelloGoodbye