我有一个简单的方法,带有一条注释,我想在我的 doxygen 主页中用作示例:
\code
void showNum(int numToDisplay){
// This is just a method to display a value.
std::cout<<"Displaying Number "<<numToDisplay<<std::endl;
}
\endcode
当生成文档时,主页将正确显示代码示例,但注释将一直到主页的左边缘。我应该使用什么字符来强制评论保持其合理性和显示?
先谢谢您的帮助。
如果没有更多信息,将很难诊断这一点,但需要检查以下几点:
- 确保代码前面有一个空行。
- 确保有四个空格缩进
- 确保评论前面的空格不是制表符
听起来好像您的代码没有被解释为代码块(由于上面列出的原因之一)。如果您可以发布至少部分包含代码块的文件,可能有助于解决这个问题。
这是一个小例子,它似乎可以满足您的要求:
/**
* @file tmp.cpp
*/
/** Brief description
*
* Long description of what the function does ...
*
* \code{.cpp}
*
* void showNum(int numToDisplay){
*
* // This is just a method to display a value.
* std::cout<<"Displaying Number "<<numToDisplay<<std::endl;
* }
*
* \endcode
*
*/
void showNum(int numToDisplay) {
std::cout << "Displaying Number " << numToDisplay << std::endl;
}
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)