我想在DoxyGen评论中使用内联代码:
Use `#define` for something..
产生以下警告:
warning: explicit link request to 'define' could not be resolved
如何逃避#符号以省略此警告?
如果我像这样使用反斜杠(\):
Use `\#define` for something..
我仍然得到同样的警告..
答案 0 :(得分:8)
答案 1 :(得分:5)
我遇到了类似的警告,但情况略有不同。我希望在生成的文档中看到"#include foo"
(引用并使用等宽字体)而不是#define
。
doxygen支持markdown表明只需在代码中编写`"#include foo"`
即可。它没有;在doxygen-flavored markdown和其他doxygen之间存在一些无证的相互作用。 Doxygen尝试将#include
作为引用名为include
的实体进行处理。写`"\#include foo"`
也不起作用。当在降价代码范围内使用时,Doxygen本身不会将反斜杠视为转义为英镑符号。
在doxygen中使用`stuff`
时要非常小心。如果stuff
很简单,你就可以了,但如果它包含任何特殊的doxygen字符,你最好还是使用别的东西。
如果你想看
Word #foo more words。
(即#foo
不是等宽字体)。只需在doxygen评论中转义哈希符号:
/*!
Word \#foo more words.
*/
单词#foo
更多单词。
(即#foo
是等宽字体)。将\c
与\#
结合使用:
/*!
Word \c \#foo more words.
*/
单词#foo bar
更多单词。
(即,#foo
和bar
一起使用等宽字体,并且不是双引号。将<tt>
与\#
结合使用:
/*!
Word <tt>\#foo bar</tt> more words.
*/
单词"#foo bar"
更多单词。
(即,#foo
和bar
一起使用等宽字体,以及围绕#foo bar
的双引号。使用\c
和**不要*反斜杠转义哈希符号:
/*!
Word \c "#foo bar" more words.
*/
最后一个很棘手。角色"
是doxygen中的特殊角色。 \c
命令对字符串"#foo bar"
进行操作,并且不插入该字符串。