C++ 体内强氧剂
我有一些代码,我想在其中记录一些注释,如:C++ 体内强氧剂,c++,doxygen,C++,Doxygen,我有一些代码,我想在其中记录一些注释,如: /*! \file best.cpp * \brief The best * * I am the best */ /*! \fn void theBestFunction(int) * I'm the best blah blah blah */ void theBestFunction(int ever) { doThings(); /*! * Does some more things */
/*! \file best.cpp
* \brief The best
*
* I am the best
*/
/*! \fn void theBestFunction(int)
* I'm the best blah blah blah
*/
void theBestFunction(int ever)
{
doThings();
/*!
* Does some more things
*/
doMoreThings();
/*!
* Checks that the things it does are the best
*/
checkBest();
}
但是当我在上面运行doxygen
时,它似乎将内部块格式化为代码片段,就好像使用了@code
或\code
命令(它们没有)。我想在体内的意见是像正常的文本格式
以前有人遇到过这种情况吗?谢谢。我设法解决了这个问题。事实证明,Doxygen以某种方式处理这些块,使它们彼此缩进,而Markdown中的缩进(与StackOverflow上的缩进非常类似)表示代码块(http://en.wikipedia.org/wiki/Markdown#Code). 我只是关闭了降价并解决了这个问题 对于将来阅读此问题的任何人,如果您仍然需要降价支持,请注意不要在第二行开始注释块--立即开始注释 将我的最小示例更改为:
/*! \fn void theBestFunction(int)
* I'm the best blah blah blah
*/
void theBestFunction(int ever)
{
doThings();
/*! Does some more things
*/
doMoreThings();
/*! Checks that the things it does are the best
*/
checkBest();
}
(注意立即开始正文注释,而不是先空行)解决了这个问题。我很确定Doxygen不能做到这一点。你说@CatPlusPlus是什么意思?Doxygen不能做哪一部分?看起来像是重复的,我尝试使用您的完整示例代码,它呈现得很好(作为普通文本)。鉴于我们有相同版本的强氧,您在问题中给出的示例似乎缺少了一些内容。您能用一个完整的最小示例更新您的问题吗(如果可能,使用默认配置文件)?
doxygen--version
只打印1.8.1
。那你能试试不同版本的强氧剂吗?