在C ++项目中,我使用doxygen和javadoc样式进行文档编制。我是javadoc的新手,我不确定这种类型的东西是否有效。
/**
* ...stuff...
* @return foo foo foo foo foo. Foo foo
* foo foo foo foo foo.
*/
即返回内容的信息(我的问题适用于所有标签)需要涵盖多行。这是自动检测还是我需要做一些特别的事情?
另外,根据我的理解,你可以有一个简短的类描述和更深入的类描述。像上面的问题一样,短类描述可以多行吗?如果是这样,这是什么语法?
如果使用{curly}大括号,则参数将延伸到下一段。段落由空行或部分指示符分隔。
return
命令被列为段落式命令。因此,您可以使用任意数量的行,添加一个额外的空行或只是启动一个新命令来结束return
。