Doxygen 多行注释

Question

我是 Doxygen 的新手，正在尝试评论我的代码。

我对评论有一些疑问：我的多行评论出现在一行中，我不想使用 \n 或 <br>.

/** 
Brief - this is a function  
Get -  
Return -  
*/  
void func1()
{
    return
}

我希望每行开始一个新行。

然而，结果是：

Brief - this is a function Get: - Return: - Post: -

我也试过：

/// Brief - this is a function
/// Get -
/// Return -  
void func1()  
{
    return
}

与上述相同的结果。

Answer 1

这种情况下的 doxygen 注释旨在忽略隐式换行，因此文本换行不会像

那样影响输出

/** This is a long comment that caused the
IDE to wrap the text and therefore
span onto multiple lines **/
int func(bool b) {
}

但在你的例子中，我认为如果你的 doxygen 的每一行都具有语义含义，如参数、return 值等，你应该使用适当的命令

/**
\brief This is a description of my function
\param[in] b This is some bool argument of my function
\return This describes the int that is returned in this case
**/
int func(bool b) {
}

参见list of available commands here。

Doxygen 多行注释

Doxygen multi line comments

c++

doxygen

doxygen-wizard