一组变量的注释
A comment for a group of variables
我正在尝试在使用 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(:)
!> @}
您可以使用 @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(:)
!> @}
我正在尝试在使用 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(:)
!> @}
您可以使用 @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(:)
!> @}