Doxygen javadoc风格标记的描述跨越多行

5
在我的C++项目中,我正在使用doxygen和javadoc风格来进行文档编写。我对javadoc比较陌生,不确定这种类型的东西是否有效。
/**
 * ...stuff...
 * @return foo foo foo foo foo. Foo foo
 * foo foo foo foo foo.
 */

即返回的信息(我的问题适用于所有标签)需要覆盖多行。这是否会自动检测到,还是我需要做一些特殊的事情?

另外,据我所了解,您可以有一个简短的类描述和一个更详细的类描述。就像上面的问题一样,简短的类描述可以超过一行吗?如果可以,语法是什么?

1个回答

4

Doxygen文档中指出:

如果使用{curly}括号,参数将延伸至下一段落。 段落由空行或节指示符界定。

return命令被列为段落样式命令。因此,您可以使用任意多行,添加一个额外的空行或只需启动新命令来结束return


网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接