Doxygen javadoc风格标签描述跨越多行

Question

在一个C++项目中，我使用了doxygen和javadoc风格的文档。我对javadoc相当陌生，我不确定这种类型的东西是否有效。

/** 
* ...stuff... 
* @return foo foo foo foo foo. Foo foo 
* foo foo foo foo foo. 
*/ 

即即将返回的信息（以及我的问题适用于所有标签）需要覆盖多行。这是自动检测还是我需要做一些特别的事情？

此外，从我的理解你可以有一个简短的类描述和更深入的类描述。像上面的问题一样，简短的课堂描述能不止一行？如果是这样，这是什么语法？

Answer 1

的doxygen docs状态

如果使用{}卷曲括号中 参数延伸直到下一个 段落。段落由 空行或 指示符分隔。

return命令被列为段落式命令。因此，您可以根据需要使用尽可能多的行，添加一个额外的空白行或者只需启动一个新命令即可结束return。