@section【セクション】1.11.0
@subsection【サブセクション】1.11.0
@subsubsection【サブサブセクション】1.11.0
@paragraph【段落】1.11.0
@subparagraph【サブ段落】1.11.0
@subsubparagraph【サブサブ段落】1.11.0
@tableofcontents【ページ内目次作成】1.8.15 / 1.11.0

@section【セクション】1.11.0
@subsection【サブセクション】1.11.0
@subsubsection【サブサブセクション】1.11.0
@paragraph【段落】1.11.0
@subparagraph【サブ段落】1.11.0
@subsubparagraph【サブサブ段落】1.11.0

メモ

概要

関連

外部リンク

構文

@section セクション名 セクション タイトル

セクション名:別ページを含めて一意
セクション タイトル:タイトル ( @link・@endlink【インライン参照ブロック】 指定可 1.11.0 )

@subsection サブセクション名 サブセクション タイトル

サブセクション名:別ページを含めて一意
サブセクション タイトル:タイトル ( @link・@endlink【インライン参照ブロック】 指定可 1.11.0 )

@subsubsection サブサブセクション名 サブサブセクション タイトル

サブサブセクション名:別ページを含めて一意
サブサブセクション タイトル:タイトル ( @link・@endlink【インライン参照ブロック】 指定可 1.11.0 )

@paragraph 段落名 段落 タイトル

段落名:別ページを含めて一意
段落 タイトル:タイトル ( @link・@endlink【インライン参照ブロック】 指定可 1.11.0 )

@subparagraph サブ段落名 サブ段落 タイトル 1.11.0

サブ段落名:別ページを含めて一意
サブ段落 タイトル:タイトル ( @link・@endlink【インライン参照ブロック】 指定可 )

@subsubparagraph サブサブ段落名 サブサブ段落 タイトル 1.11.0

サブサブ段落名:別ページを含めて一意
サブサブ段落 タイトル:タイトル ( @link・@endlink【インライン参照ブロック】 指定可 )

例:基本

例:タイトルに @link・@endlink【インライン参照ブロック】指定 1.11.0

/// @page page_section_link ページ:@section【セクション】等 + @link・@endlink【インライン参照ブロック】
///
/// @section section_link セクション〔下の階層 @link subsection_link サブセクションへ @endlink @emoji :arrow_double_down:〕
/// セクション コンテンツ
///
/// ---
/// @subsection subsection_link サブセクション〔下の階層 @link subsubsection_link サブサブセクションへ @endlink @emoji :arrow_double_down:〕
/// サブセクション コンテンツ
///
/// ---
/// @subsubsection subsubsection_link サブサブセクション〔下の階層 @link paragraph_link 段落へ @endlink @emoji :arrow_double_down:〕
/// サブサブセクション コンテンツ
///
/// ---
/// @paragraph paragraph_link 段落〔下の階層 @link subparagraph_link サブ段落へ @endlink @emoji :arrow_double_down:〕
/// 段落 コンテンツ
///
/// ---
/// @subparagraph subparagraph_link サブ段落〔下の階層 @link subsubparagraph_link サブサブ段落へ @endlink @emoji :arrow_double_down:〕
/// サブ段落 コンテンツ
///
/// ---
/// @subsubparagraph subsubparagraph_link サブサブ段落〔最上位階層 @link section_link セクションへ @endlink @emoji :arrow_double_up:〕
/// サブサブ段落 コンテンツ

HTML出力例

ページ:@section【セクション】等 + @link・@endlink【インライン参照ブロック】

セクション コンテンツ


サブセクション コンテンツ


サブサブセクション コンテンツ


段落 コンテンツ


サブ段落 コンテンツ


サブサブ段落 コンテンツ


@tableofcontents【ページ内目次作成】1.8.15 / 1.11.0

メモ

概要

表示範囲

1.8.15

関連

外部リンク

構文

@tableofcontents 1.8.15
@tableofcontents[{[オプション[:レベル]]...[,オプション[:レベル]]}] 1.8.15

オプション1.8.15:出力対象 (HTML | LaTeX | XML | DocBook)
    全て省略:HTMLXML
レベル1.8.15:表示階層レベル
    1 ~ 5:指定レベルまで表示 1.11.0
    省略 / 6以上:5 (すべて表示) 1.11.0
    1 ~ 6:指定レベルまで表示 1.11.0
    省略 / 範囲外:6 (すべて表示) 1.11.0

{ はコマンド直後に記述

レベル指定なし

/// @page page_toc 目次付きページ
/// @tableofcontents
///
/// @section section1 セクション1
/// セクション1 コンテンツ
///
/// ---
/// @section section2 セクション2
/// セクション2 コンテンツ
/// @subsection subsection2 サブセクション2
/// サブセクション2 コンテンツ
///
/// ---
/// @section section3 セクション3
/// セクション3 コンテンツ
/// @subsection subsection3 サブセクション3
/// サブセクション3 コンテンツ
/// @subsubsection subsubsection3 サブサブセクション3
/// サブサブセクション3 コンテンツ
///
/// ---
/// @section section4 セクション4
/// セクション4 コンテンツ
/// @subsection subsection4 サブセクション4
/// サブセクション4 コンテンツ
/// @subsubsection subsubsection4 サブサブセクション4
/// サブサブセクション4 コンテンツ
/// @paragraph paragraph4 段落4
/// 段落4 コンテンツ
///
/// ---
/// @section section5 セクション5
/// セクション5 コンテンツ
/// @subsection subsection5 サブセクション5
/// サブセクション5 コンテンツ
/// @subsubsection subsubsection5 サブサブセクション5
/// サブサブセクション5 コンテンツ
/// @paragraph paragraph5 段落5
/// 段落5 コンテンツ
/// @subparagraph subparagraph5 サブ段落5
/// サブ段落5 コンテンツ
///
/// ---
/// @section section6 セクション6
/// セクション6 コンテンツ
/// @subsection subsection6 サブセクション6
/// サブセクション6 コンテンツ
/// @subsubsection subsubsection6 サブサブセクション6
/// サブサブセクション6 コンテンツ
/// @paragraph paragraph6 段落6
/// 段落6 コンテンツ
/// @subparagraph subparagraph6 サブ段落6
/// サブ段落6 コンテンツ
/// @subsubparagraph subsubparagraph6 サブサブ段落6
/// サブサブ段落6 コンテンツ

HTML出力例

目次付きページ
セクション1

セクション1 コンテンツ


セクション2

セクション2 コンテンツ

サブセクション2

サブセクション2 コンテンツ


セクション3

セクション3 コンテンツ

サブセクション3

サブセクション3 コンテンツ

サブサブセクション3

サブサブセクション3 コンテンツ


セクション4

セクション4 コンテンツ

サブセクション4

サブセクション4 コンテンツ

サブサブセクション4

サブサブセクション4 コンテンツ

段落4

段落4 コンテンツ


セクション5

セクション5 コンテンツ

サブセクション5

サブセクション5 コンテンツ

サブサブセクション5

サブサブセクション5 コンテンツ

段落5

段落5 コンテンツ

サブ段落5

サブ段落5 コンテンツ


セクション6

セクション6 コンテンツ

サブセクション6

サブセクション6 コンテンツ

サブサブセクション6

サブサブセクション6 コンテンツ

段落6

段落6 コンテンツ

サブ段落6

サブ段落6 コンテンツ

サブサブ段落6

サブサブ段落6 コンテンツ

レベル指定

// 上記 @tableofcontents を以下に変更

/// @tableofcontents{HTML:2}

HTML出力例

目次付きページ
セクション1

セクション1 コンテンツ


セクション2

セクション2 コンテンツ

サブセクション2

サブセクション2 コンテンツ


セクション3

セクション3 コンテンツ

サブセクション3

サブセクション3 コンテンツ

サブサブセクション3

サブサブセクション3 コンテンツ


セクション4

セクション4 コンテンツ

サブセクション4

サブセクション4 コンテンツ

サブサブセクション4

サブサブセクション4 コンテンツ

段落4

段落4 コンテンツ


セクション5

セクション5 コンテンツ

サブセクション5

サブセクション5 コンテンツ

サブサブセクション5

サブサブセクション5 コンテンツ

段落5

段落5 コンテンツ

サブ段落5

サブ段落5 コンテンツ


セクション6

セクション6 コンテンツ

サブセクション6

サブセクション6 コンテンツ

サブサブセクション6

サブサブセクション6 コンテンツ

段落6

段落6 コンテンツ

サブ段落6

サブ段落6 コンテンツ

サブサブ段落6

サブサブ段落6 コンテンツ