我一直在尝试让DOxygen正确格式化并输出我使用屏蔽代码块的markdown文件和内联代码标记的后退标记,就像我在GitHub上使用一样。
DOxygen的默认配置没有任何废话,所以我玩了,“让我们看看这个设置做了什么!”游戏。我也一直在浏览他们过去几年的错误报告,并且没有找到任何可以绕过我的问题的明确修复或配置,因为它们中没有一个代码示例能够完成。此外,反引号之间的内容正在获得特殊格式,但它不是您习惯在SO和GH上看到的代码样式格式 - 例如,它没有background color
。与我习以为常的文章相比,在浏览文档时,字体略有不同。
问题的关键在于在降价代码块中获取DOxygen识别语法,以便不会完全破坏从代码块中的注释开始的文件输出。而不是像这样格式化:
Markdown 东西
#include <blarg>
/*!
* \brief brief description here
* \file filename.ext
*/
class ClassName{
private:
int magicnumber;
public:
void dostuff();
};
一些markdown
内容
我最终会从DOxygen获得:
Markdown 东西
``#include
/ *! **
或者,其他一些类似的破坏输出。我最接近修复的是this question,但是当我尝试这个时,简短的描述实际上并不是来自DOxygen生成的文件,即使HTML页面本身看起来很好,减去了丑陋的解决方法。
因此,从默认配置中,我需要设置什么才能获得我正在寻找的功能?我有其他工具可以处理我对html转换的降价,但我想统一文档并尽可能利用DOxygen的功能。
我尝试过DOxygen版本1.8.7和1.8.11
编辑:这只是我尝试的一种解决方案。添加它们都是不现实的,并使这个问题变得巨大。我还尝试了~~~
,```lang
/ ~~~lang
,~~~{lang}
和~~~{.lang}
。还请注意从早期到类似问题的链接,我试图逃避特殊字符。
Markdown **stuff**
```
#include <blarg>
/*!
* \brief brief description here
* \file filename.ext
*/
class ClassName{
private:
int magicnumber;
public:
void dostuff();
};
```
Some `markdown` stuff
Markdown **东西**
这里的简要说明
``#include
/ *! **