@code・@endcode【コードブロック】
@include【コードブロック (ファイル)】1.8.15
@includelineno【行番号付きコードブロック (ファイル)】1.8.15
@snippet【コードブロック (ファイル指定部分)】1.8.151.9.7
@snippetlineno【行番号付きコードブロック (ファイル指定部分)】1.8.15
@verbatim・@endverbatim【テキストブロック】
@verbinclude【テキストブロック (ファイル)】
@code【コードブロック (開始)】
@endcode【コードブロック (終了)】
メモ
- コードブロックを記述
- コードブロック内のクラス・メンバ等は自動的にリンク設定
- 関連
構文
@code [{ドット付ファイル拡張子 | .unparsed}]
コードブロック
@endcode
ドット付ファイル拡張子:
拡張子指定:対応する言語として解析
省略:コマンドの記述ファイルに従う
.unparsed:そのまま出力 (解析不要)
例:{.cpp}・{.py}・{.unparsed}
例
/// @code
/// class MyClass
/// {
/// ...
/// };
/// @endcode
///
/// @code {.py}
/// class MyClass:
/// ...
/// @endcode
HTML出力例
class MyClass
{
...
};
class MyClass:
...
@include【コードブロック (ファイル)】1.8.15
@includelineno【行番号付きコードブロック (ファイル)】1.8.15
メモ
- ファイル内容の全体をコードブロックとして挿入
- 各種オプション指定1.8.15:@include【コードブロック (ファイル)】
- 行番号付き:@includelineno【行番号付きコードブロック (ファイル)】
廃止 (下位互換の為、残存) 1.8.15
代替:@include【コードブロック (ファイル)】のオプション指定 - コードブロック内のクラス・メンバ等は自動的にリンク設定
- EXAMPLE_PATH【例ファイルパス】 でファイルのパス (複数指定可)を指定、 一意でない場合は絶対パスの指定が可能
- ファイルのエンコードは、INPUT_ENCODING【ファイルのエンコード】・ INPUT_FILE_ENCODING【個別ファイルのエンコード】
- 間引いて挿入する場合、@dontinclude【コードブロック (ファイル・非表示)】を参照
- ファイル内容の指定部分をコードブロックとして挿入するには、@snippet【コードブロック (ファイル指定部分)】・@snippetlineno【行番号付きコードブロック (ファイル指定部分)】
- 関連
- 外部リンク
構文
@include[{オプション}]1.8.15 ファイル名
@includelineno ファイル名1.8.15
{オプション}1.8.15 (@include 直後に指定)
{lineno}:行番号付き (@includelineno【行番号付きコードブロック (ファイル)】1.8.15 と同等)
{doc}:コマンド有効ドキュメント形式 (例外コマンドあり / @includedoc【ファイル挿入 (コマンド有効)】1.8.15 と同等)
例
/// ■@@include (通常:{lineno}未指定)
/// @include include.cpp
/// ■@@include{lineno}:行番号付き
/// @include{lineno} include.cpp
/// ■@@include (通常:{doc}未指定)
/// @include include.txt
/// ■@@include{doc}:ドキュメント形式 (コマンド有効)
/// @include{doc} include.txt
///
/// ■@@includelineno
/// @includelineno include.cpp
【include.cpp】
class ClassInclude
{
};
【include.txt】
@version 1.2.3
@author 開発者
@copyright 著作権情報
【HTML出力例】
■@include (通常:{lineno}未指定)
class ClassInclude
{
};
■@include{lineno}:行番号付き
1class ClassInclude
2{
3};
■@include (通常:{doc}未指定)
@version 1.2.3
@author 開発者
@copyright 著作権情報
■@include{doc}:ドキュメント形式 (コマンド有効)
- バージョン
- 1.2.3
- 著作権所有
- 著作権情報
■@includelineno
1class ClassInclude
2{
3};
@snippet【コードブロック (ファイル指定部分)】1.8.151.9.7
@snippetlineno【行番号付きコードブロック (ファイル指定部分)】1.8.15
メモ
- ファイル内容の指定部分をコードブロックとして挿入
- 各種オプション指定1.8.15:@snippet【コードブロック (ファイル指定部分)】
- 行番号付き:@snippetlineno【行番号付きコードブロック (ファイル指定部分)】
廃止 (下位互換の為、残存) 1.8.15
代替:@snippet【コードブロック (ファイル指定部分)】のオプション指定 - EXAMPLE_PATH【例ファイルパス】 でファイルのパス (複数指定可)を指定、 一意でない場合は絶対パスの指定が可能
- ファイルのエンコードは、INPUT_ENCODING【ファイルのエンコード】・ INPUT_FILE_ENCODING【個別ファイルのエンコード】
- ファイル内容の全体をコードブロックとして挿入するには、@include【コードブロック (ファイル)】・@includelineno【行番号付きコードブロック (ファイル)】
- 関連
- 外部リンク
構文
@snippet[{オプション}]1.8.15 ファイル名 スニペット識別子
@snippetlineno ファイル名 スニペット識別子1.8.15
{オプション}1.8.15 (@snippet 直後に指定)
{lineno}:行番号付き (@snippetlineno【行番号付きコードブロック (ファイル指定部分)】1.8.15 と同等)
{trimleft}1.9.7:左側余白削除 (TAB_SIZE【タブサイズ】考慮)
{doc}:コマンド有効ドキュメント形式 (例外コマンドあり / @snippetdoc【ファイル部分挿入 (コマンド有効)】1.8.15 と同等)
※指定ファイル内の[スニペット識別子]で囲まれた部分が対象
例
/// ■@@snippet (通常:{lineno}未指定)
/// @snippet snippet.cpp Snippet1
/// ■@@snippet{lineno}:行番号付き
/// @snippet{lineno} snippet.cpp Snippet1
/// ■@@snippet (通常:{trimleft}未指定)
/// @snippet snippet.cpp SnippetTrimLeft
/// ■@@snippet{trimleft}:左側余白削除
/// @snippet{trimleft} snippet.cpp SnippetTrimLeft
/// ■@@snippet (通常:{doc}未指定)
/// @snippet snippet.cpp SnippetDoc
/// ■@@snippet{doc}:ドキュメント形式 (コマンド有効)
/// @snippet{doc} snippet.cpp SnippetDoc
///
/// ■@@snippetlineno
/// @snippetlineno snippet.cpp Snippet2
【snippet.cpp】
// [Snippet1]
class ClassSnippet1
{
};
// [Snippet1]
// [Snippet2]
class ClassSnippet2
{
};
// [Snippet2]
class ClassSnippet3
{
// [SnippetTrimLeft]
int method() {
int sum = 0;
for (int i = 1; i <= 10; i++) {
sum += i;
}
return sum;
}
// [SnippetTrimLeft]
};
/*
[SnippetDoc]
@version 1.2.3
@author 開発者
@copyright 著作権情報
[SnippetDoc]
*/
【HTML出力例】
■@snippet (通常:{lineno}未指定)
class ClassSnippet1
{
};
■@snippet{lineno}:行番号付き
2class ClassSnippet1
3{
4};
■@snippet (通常:{trimleft}未指定)
int method() {
int sum = 0;
for (int i = 1; i <= 10; i++) {
sum += i;
}
return sum;
}
■@snippet{trimleft}:左側余白削除
int method() {
int sum = 0;
for (int i = 1; i <= 10; i++) {
sum += i;
}
return sum;
}
■@snippet (通常:{doc}未指定)
@version 1.2.3
@author 開発者
@copyright 著作権情報
■@snippet{doc}:ドキュメント形式 (コマンド有効)
- バージョン
- 1.2.3
- 著作権所有
- 著作権情報
■@snippetlineno
8class ClassSnippet2
9{
10};
@verbatim【テキストブロック (開始)】
@endverbatim【テキストブロック (終了)】
メモ
構文
@verbatim
テキストブロック
@endverbatim
例
/**
@verbatim
The quick brown fox jumps over the lazy dog.
The quick brown @em fox jumps over the lazy @b dog.
The quick brown fox jumps over the lazy dog.
@endverbatim
*/
HTML出力例
The quick brown fox jumps over the lazy dog. The quick brown @em fox jumps over the lazy @b dog. The quick brown fox jumps over the lazy dog.
@verbinclude【テキストブロック (ファイル)】
メモ
- ファイル内容をテキストブロックとして挿入
- コマンドは無効
- EXAMPLE_PATH【例ファイルパス】 でファイルのパス (複数指定可)を指定、 一意でない場合は絶対パスの指定が可能
- ファイルのエンコードは、INPUT_ENCODING【ファイルのエンコード】・ INPUT_FILE_ENCODING【個別ファイルのエンコード】
- 関連
構文
@verbinclude ファイル名
例
/// @verbinclude verbinclude.txt
【verbinclude.txt】
The quick brown fox jumps over the lazy dog.
The quick brown @em fox jumps over the lazy @b dog.
The quick brown fox jumps over the lazy dog.
HTML出力例
The quick brown fox jumps over the lazy dog. The quick brown @em fox jumps over the lazy @b dog. The quick brown fox jumps over the lazy dog.