doxygen /** 样式创建启用降价的虚假代码块答案

【问题标题】：doxygen /** style creates spurious code blocks with markdown enableddoxygen /** 样式创建启用降价的虚假代码块
【发布时间】：2013-12-27 00:48:44
【问题描述】：

我们有一个广泛使用 Doxygen 的大型 C++ 项目。当 Doxygen 添加降价支持时，我们生成的文档突然出现了不需要的“盒装”代码块，其中包含许多文档类和成员的第一批注释行。禁用 markdown 支持解决了这个问题，但我们希望能够使用 markdown。

问题显然是我们对 Doxygen cmets 使用了/** 样式。为了紧凑，我们在同一行开始注释，特别是对于短 cmets，我们不缩进评论的其余部分。我猜 Doxygen 将它作为缩进行发送到 markdown，因此 markdown 将其放在代码块中。像这样的评论很好用：

/** This a short comment (works). */

但是像这样的 cmets 最终会将第一行视为已放置在代码块中：

/** This is a somewhat longer comment that ended up
being wrapped to a second line (first line treated as code). */

通过以下任一方式重新格式化可以解决问题：

/** This is a somewhat longer comment that ended up
    being wrapped to a second line (works). */

/** 
This is a somewhat longer comment that ended up
being wrapped to a second line (works). */

我们有成千上万的类和成员记录在上面的紧凑形式中，并且希望能够在不改变这种风格的情况下启用降价。有什么方法可以让 Doxygen 不生成这些不需要的代码块？

我正在使用 Doxygen 1.8.5。

【问题讨论】：

作为一个实验，我刚刚扩展了以降价为中心的 doxygen INPUT 的范围，以包含大量 C++ 代码。我没有看到这个，但是我们的 C++ cmets 在左下角有一个前面的星号，所以这可能是第三种情况确实工作。抱歉，这对您的问题没有太大帮助。

标签： markdown doxygen

【解决方案1】：

我看到了您的问题，并且我希望用户真正想要使用代码块开始评论的情况非常罕见。

在 doxygen 中改变这一点实际上很容易。如果您可以在此处将其作为错误报告提交：https://bugzilla.gnome.org/enter_bug.cgi?product=doxygen，那么我将针对此错误将修复推送到 GitHub。

【讨论】：