Doxygen Markdown

Doxygen 是一种常用的代码文档工具（适用于包括 C++，C#和 Java 的语言），它也支持使用 Markdown。除了标准的 Markdown 语法之外，还有许多特定于 Doxygen 的元素 。

主要功能是使用 @ref 标签作为参考，以及这些可以参考的 @page，@section/@subsection 和 @anchor 元素。

@ref <name> [text]

此元素创建一个链接（即引用）到已在文档中其他位置定义的命名节，子节，页面或锚点。 （参见 Doxygen 参考 ）

第一个参数（name）应该与你要链接的部分，子部分，页面或锚点的名称相匹配。

第二个可选参数（text）应该用双引号封装，并定义引用链接在页面上的显示内容。如果未使用，该链接将显示为参考中使用的标题。

@section <section-name>（部分标题）

此元素定义节名称。它在视觉上等同于 Markdown 中的 # 元素，但它也将定义一个可以链接到文档其他部分的引用。 （参见 Doxygen 参考 ）

第一个参数 section-name 定义了 @ref 元素可以使用的引用名称。这不能包含任何空格。

第二个参数 section title 是一个单词字符串（可以用空格分隔），它定义了标题在页面上显示的内容。

例

@section Intro Introduction

This is some text in my introduction.

@section Body Body Paragraph

This is some text in my body, where I refer to the @ref Intro.

输出

介绍

这是我的介绍中的一些文字。

身体段落

这是我身体中的一些文字，我在这里引用了简介。

注意：上面的引言一词将显示为将跳转到简介标题的链接。