在C ++项目中,我正在使用doxygen和javadoc样式进行文档编写。我对javadoc还是相当陌生,不确定这种事情是否有效。
/**
* ...stuff...
* @return foo foo foo foo foo. Foo foo
* foo foo foo foo foo.
*/
Run Code Online (Sandbox Code Playgroud)
即返回的信息(我的问题适用于所有标签)需要涵盖多行。是否会自动检测到此信息,或者我需要做一些特别的事情?
另外,据我了解,您可以使用简短的类描述和更深入的类描述。像上面的问题一样,简短的类描述可以超过一行吗?如果是这样,其语法是什么?