c++ - 变量后的 Doxygen 多行注释

Question

我已经用 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 输出时，变量描述包含一个“<”:“This is a very long text about my variable.This < is a very long text about my variable.”

我正在使用当前的 doxygen 1.8.11 并且我已经设置了 MULTILINE_CPP_IS_BRIEF = NO。

根据doxygen homepage (请参阅“在成员之后放置文档”)这应该有效，还是我遗漏了什么？

Answer 1

试试这个:

//! 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。