变量后的Doxygen多行注释

Doxygen multi-line comment after variable

本文关键字：多行注释 Doxygen 变量      更新时间：2023-10-16

我已经用doxygen语法记录了一个结构。

//! This struct contains some info
typedef struct myInfo
{
    int variable1;  //!< This is a very long text about my variable. This
                    //!< is a very long text about my variable.
} myInfo;

当我生成html/chm输出时，变量描述包含一个"<"："这是关于我的变量的很长的文本。这<是关于我变量的很短的文本。"

我使用的是当前的doxygen 1.8.11，我已经设置了MULTILINE_CPP_IS_BRIEF=NO

根据doxygen主页（请参阅"将文档放在成员后面"），这应该是有效的，还是我遗漏了什么？

试试这个：

//! This struct contains some info
typedef struct myInfo
{
    int variable1;  /**< This is a very long text about my variable. This
                         is a very long text about my variable.*/
} myInfo;

然后你会收到一条非常"长"的短信。

如果需要多行注释，请在每行的末尾放一个n。

相关文章：