【问题标题】:How to get \s\p in doxygen documentation?如何在 doxygen 文档中获取 \s\p?
【发布时间】:2012-08-07 10:05:11
【问题描述】:

我想在 doxygen 生成的最终文档中包含 \s\p。下面是来自 Java 文件的示例注释块:

/**
 * @section Sample sample
 * Need to use \s\p in the file.
 *
 */

并且生成的文档应该是 Need to use \s\p in the file. 但是,当我运行 doxygen 时,它会将 \s\p 替换为 <computeruotput/> 并且 doxygen XML 输出中的结果是 Need to use <computeruotput/> in the file. 我如何才能在最终获得 \s\p输出而不是<computeruotput/>?

【问题讨论】:

标签: java doxygen


【解决方案1】:

这是因为反斜杠\ 表示special command in doxygen\p 例如用于用打字机字体格式化文本。要在输出中获得\s\p,请尝试使用\\s\\p,即将一个反斜杠\ 替换为两个\\\\ 是 doxygen 中的一个特殊命令,它只打印一个 \

【讨论】:

  • 感谢 Chris 提供的宝贵信息。
  • 没问题。如果它解决了您的问题,请不要忘记接受此答案,请参阅How does accepting an answer work?
  • 我刚刚注意到您已经以separate question 的身份提出了这个问题。请不要重复发布,如果您需要更改任何内容或添加其他信息,请编辑第一个问题。重复的问题可能会被关闭。无论如何,我对其他问题的评论没有帮助吗?
  • 感谢 Chris 提供的宝贵信息,这些信息非常有帮助。当 java 中的注释包含 标签时,我遇到了同样的问题。您能否告诉我为什么它创建 而不是实际标签?另外,您能否让我知道会生成 的其他特殊字符/代码是什么?
  • @Doxyuser 所有特殊命令都在我的问题和我之前评论的链接中。浏览该页面,看看他们都做了什么。如果您想在最终输出中包含<code> 之类的标签,请使用\verbatim\endverbatim 命令将它们包装起来,正如我在comment to your previous post 中提到的那样。
猜你喜欢
  • 1970-01-01
  • 2023-03-19
  • 2016-01-25
  • 2011-09-14
  • 2023-02-22
  • 2021-02-04
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
相关资源
最近更新 更多