代码块中的多行注释不会出现在 README.md 中

Question

我目前正在记录如何在我的一个项目上记录代码，为此我正在编写一个 README.md 文档，我将其作为我使用 Doxygen 1.8.13 生成的文档的首页.

我试图在README中放一些例子作为代码块，但是Doxygen使用的注释是多行注释，代码块在生成Markdown页面时似乎跳过了多行注释。

下面是一个例子。

这是我想要的：

/** @def MACRO
 *  @brief Short description of the macro MACRO
 */
#define MACRO 0

这是我必须写的代码块才能出现（“@”符号似乎有问题）：

/** \@def MACRO
 *  \@brief Short description of the macro MACRO
 */
#define MACRO 0

这是我用上面的代码块生成文档时得到的结果：


#define MACRO 0

我知道多行注释会出现在代码块中而不指定代码块的语言（写三个反引号“`”而不是三个反引号和c），但我想继续强调语法C代码。

你知道如何解决“@”的问题吗？最重要的是，你知道是否有办法让多行注释出现在代码块中，同时保持 C 代码的高亮显示？

提前致谢！

Answer 1

当我有以下源文件时Readme.md:

The required docu:

```
/** @def MACRO
 *  @brief Short description of the macro MACRO
 */
#define MACRO 0
```

和 doxygen 设置 (Doxyfile):

USE_MDFILE_AS_MAINPAGE=Readme.md

我得到 1.9.3 (c0b9eafbfb53286ce31e75e2b6c976ee4d345473) 版本，我得到：

所以从这个问题来看，我认为这是必需的（当不添加确切的代码（作为文本）和原始问题中的结果输出时）。

如果有人想像 C 那样渲染它，应该使用代码作为开头的反引号：```c 并且还应该设置 STRIP_CODE_COMMENTS=NO 否则评论将不会显示。这样做时我得到：

Multiline comments in code blocks don't appear in README.md