对一组变量的评论

时间:2015-12-15 20:39:56

标签: fortran doxygen fortran90

我正在尝试使用doxygen 1.7.3在Fortran 90代码文档中对一组变量使用注释:

!> The parameters defined to convert R to Q
real(wp),allocatable :: A(:)
integer,allocatable :: B(:)
integer,allocatable :: C(:)

然而,这只会产生第一个变量的注释。我怎么能对这三个人都有评论?

更新 就像@Alexander Vogt回复的后续行动一样: 如果使用以下内容,结果看起来非常好:

!> @name groupname 
!! The parameters defined to convert R to Q
!> @{
real(wp),allocatable :: A(:)
integer,allocatable :: B(:)
integer,allocatable :: C(:)
!> @}

1 个答案:

答案 0 :(得分:1)

您可以使用@defgroup <name> <description> @{ ... @}

对变量进行分组
!> @defgroup groupname The parameters defined to convert R to Q
!> @{
real(wp),allocatable :: A(:)
integer,allocatable :: B(:)
integer,allocatable :: C(:)
!> @}

有关详细信息,请参阅the Doxygen manual。描述应该与您的评论非常接近。

请注意,您还可以向变量本身添加注释。

或者,您可以使用"Member groups"

!> @name groupname The parameters defined to convert R to Q
!> @{
real(wp),allocatable :: A(:)
integer,allocatable :: B(:)
integer,allocatable :: C(:)
!> @}