如何转义氧气内联代码中的特殊命令

Question

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

Use `#define` for something..

产生以下警告:

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

如何转义#符号以省略此警告?

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

Use `#define` for something..

我仍然得到相同的警告…

Answer 1

我遇到了一个类似的警告，但在一个稍微不同的上下文中。我希望在生成的文档中看到"#include foo"(引号和等宽字体)而不是#define。

什么不行

氧支持markdown，这表明只需在代码中编写`"#include foo"`就可以达到目的。它不;在氧气味的markdown和其他氧气之间有一些未被记录的相互作用。氧试图将#include处理为对某个名为include的实体的引用。写`"#include foo"`也不起作用。当在markdown code span中使用反斜杠时，oxygen proper不认为反斜杠是转义磅符号。

在氧气中使用`stuff`要非常小心。如果stuff是简单的，你会好的，但你最好使用其他东西，如果它包含任何特殊的氧字符。

怎么做

如果你想看

• Word #foo more words.
  (即，#foo不是等宽字体)。只需转义氧注释中的散列符号:

  /*! 
    Word #foo more words.
   */
  

• Word #foo more words.
  (例如，#foo是等宽字体)。将c与#结合使用:

  /*! 
    Word c #foo more words.
   */
  

• Word #foo bar more words.
  (即，#foo和bar使用等宽字体，并且没有双引号)。将<tt>与#结合使用:

  /*! 
    Word <tt>#foo bar</tt> more words.
   */
  

• Word "#foo bar" more words.
  (例如，#foo和bar是等宽字体，以及围绕#foo bar的双引号)。使用c和**不要*反斜杠转义哈希符号:

  /*! 
    Word c "#foo bar" more words.
   */
  

最后一个是棘手的。"是氧中的一个特殊字符。c命令对字符串"#foo bar"进行操作，该字符串不被插入。

Answer 2

您可能想使用oxygen的c和#特殊命令来为下一个单词提供代码格式:

Use c #define for something..