如何在DoxyGen内联代码中转义特殊命令

Question

我想在DoxyGen注释中使用内联代码:

Use `#define` for something..

产生以下警告:

warning: explicit link request to 'define' could not be resolved

如何逃避#符号以省略此警告？

如果我像这样使用反斜杠(\):

Use `\#define` for something..

我仍然得到同样的警告..

Answer 1

您可能希望使用doxygen \c和\#特殊命令为下一个单词提供代码格式:

Use \c \#define for something..

Answer 2

我遇到了类似的警告,但情况略有不同.我希望在生成的文档中看到"#include foo"(引用并使用等宽字体)#define.

什么行不通

doxygen支持markdown表明只需编写`"#include foo"`代码即可.它没有; 在doxygen-flavored markdown和其他doxygen之间存在一些无证的相互作用.Doxygen尝试将其#include作为引用某个名为的实体来处理include.写作`"\#include foo"`也不起作用.当在降价代码范围内使用时,Doxygen本身不会将反斜杠视为转义为英镑符号.

`stuff`在doxygen中使用时要非常小心.如果stuff很简单,你会没事的,但如果它包含任何特殊的doxygen字符,你最好还是使用别的东西.

什么工作

如果你想看到

• 单词#foo更多单词.
  (即,#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",并且不对该字符串进行插值.