C++ 如何在Doxygen内联代码中转义特殊命令
我想在Doxygen注释中使用内联代码:C++ 如何在Doxygen内联代码中转义特殊命令,c++,c,doxygen,C++,C,Doxygen,我想在Doxygen注释中使用内联代码: Use `#define` for something.. 这将产生以下警告: warning: explicit link request to 'define' could not be resolved 我怎样才能避开#符号而忽略此警告 如果我像这样使用反斜杠(\): Use `\#define` for something.. 我仍然收到相同的警告。您可能希望使用doxygen和特殊命令为下一个单词提供代码格式: Use \c \#defi
Use `#define` for something..
这将产生以下警告:
warning: explicit link request to 'define' could not be resolved
我怎样才能避开#符号而忽略此警告
如果我像这样使用反斜杠(\):
Use `\#define` for something..
我仍然收到相同的警告。您可能希望使用doxygen和特殊命令为下一个单词提供代码格式:
Use \c \#define for something..
我遇到了一个类似的警告,但背景略有不同。我想看到的是
“#include foo”
(引用并以单间距字体),而不是生成的文档中的#define
什么不起作用
doxygen支持markdown,这表明只需在代码中编写`“include foo”`
就可以了。事实并非如此;有一些未记录的互动之间的强氧味降价和其余的强氧。Doxygen试图将该#include
处理为对名为include
的实体的引用。写“\\\35; include foo”`
也不管用。在标记代码范围中使用时,Doxygen本身不将反斜杠视为转义英镑符号
在doxygen中使用`stuff`
时要非常小心。如果stuff
很简单,您就可以了,但是如果它包含任何特殊的doxygen字符,您最好使用其他东西
什么有效
如果你想看
- 单词#更多单词。
(即,
不是等距字体)。只需在doxygen注释中转义哈希符号:#foo
/*! Word \#foo more words. */
- 单词
更多单词。#foo
(即,
采用单间距字体)。将#foo
与\c
\\\code>结合使用:
- 单词
更多单词。#foo bar
(即,
和#foo
采用单间距字体,且不双引号)。将栏
与\\\code>结合使用:
最后一个很棘手。字符
“
是doxygen中的一个特殊字符。\c
命令对字符串“#foo bar进行操作“
,且该字符串未插值。尝试添加?@LightnessRacesinOrbit-这是一个未记录的错误功能。riotάu starter明确提到反斜杠转义在由反斜杠分隔的代码范围内不起作用。@DavidHammen:πάνταῥεῖ'两年前发布的答案显示了有文件证明的解决方案。@LightnessRacesinOrbit-我完全不同意。这是一种方法。但是,在doxygen文档中没有提到用backticks分隔的代码范围与doxygen本身之间的交互。特别是,没有提到doxygen的特殊字符不能在标记代码范围内转义。就我而言,这是一个错误。@DavidHammen:请随意写你自己的答案。就我个人而言,两年前我就把它放在床上了。@LightnessRacesinOrbit-我确实写了我自己的答案。我遇到这个问题是因为我收到了相同的消息,但我希望看到生成的文档(包括引号)中以单间距字体表示的“#foo bar…”
。
/*!
Word \c \#foo more words.
*/
/*!
Word <tt>\#foo bar</tt> more words.
*/
/*!
Word \c "#foo bar" more words.
*/