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.

輸出

介紹

這是我的介紹中的一些文字。

身體段落

這是我身體中的一些文字，我在這裡引用了簡介。

注意：上面的引言一詞將顯示為將跳轉到簡介標題的連結。