@file【ファイル情報】
@fileinfo【ファイル名 (インライン)】1.9.5
@lineinfo【行番号 (インライン)】1.9.5
@namespace【名前空間】
@includedoc【ファイル挿入 (コマンド有効)】1.8.15下位互換1.11.0
@snippetdoc【ファイル部分挿入 (コマンド有効)】1.8.15下位互換1.11.0

@file【ファイル情報】

メモ

概要

  • ファイル情報を記述
    • グローバルな関数・変数・型定義 (typedef)・列挙型 (enum)・構造体 等を出力する場合、必須 (@file のみで可)
    • 自ファイルでは、通常はファイル名省略
      別ファイルに記述する場合にファイル名指定

関連

外部リンク

構文

@file [ファイル名]

ファイル名：一意でない場合、パスを含むことが可能 (INPUT【ソースファイル名・ディレクトリ名】)
    省略：現在のファイルが対象

例

/// @file
/// @brief このファイルの概要
/// @author このファイルの開発者
/// @date このファイルの作成日
/// @details このファイルの詳細

/// @file ～.cpp
/// @brief 別ファイルの概要
/// @author 別ファイルの開発者
/// @date 別ファイルの作成日
/// @details 別ファイルの詳細


/// @file

/// @brief グローバル変数の概要
int valueGlobal;

/// @brief グローバル関数の概要
void funcGlobal() {}

@fileinfo【ファイル名 (インライン)】1.9.5

メモ

概要

  • ファイル名をインライン出力
    • ファイル名・拡張子・フルパス名 等を指定

関連

外部リンク

構文

@fileinfo[{オプション}]

オプション: 出力部分 (下記参照)
オプション備考
directoryファイルのディレクトリ
extensionファイルの拡張子
filename
{ }を含めて省略		ファイル名 (拡張子あり)
fullフルパス名
nameファイル名 (拡張子なし)

例

【ver-1-9-5.cpp】

/// @file
/// 行番号：@lineinfo@n
/// ファイル名 (インライン)@n
/// ファイルのディレクトリ：@fileinfo{directory}@n
/// ファイルの拡張子：@fileinfo{extension}@n
/// ファイル名 (拡張子あり)：@fileinfo{filename}@n
/// 省略：@fileinfo@n
/// フルパス名：@fileinfo{full}@n
/// ファイル名 (拡張子なし)：@fileinfo{name}@n
/// 行番号：@lineinfo

【HTML出力例】

行番号：2
ファイル名 (インライン)
ファイルのディレクトリ：C:/～
ファイルの拡張子：cpp
ファイル名 (拡張子あり)：ver-1-9-5.cpp
省略：ver-1-9-5.cpp
フルパス名：C:/～/ver-1-9-5.cpp
ファイル名 (拡張子なし)：ver-1-9-5
行番号：10

@lineinfo【行番号 (インライン)】1.9.5

メモ

概要

  • ファイルの行番号をインライン出力

関連

外部リンク

構文

@lineinfo

例

【ver-1-9-5.cpp】

/// @file
/// 行番号：@lineinfo@n
/// ファイル名 (インライン)@n
/// ファイルのディレクトリ：@fileinfo{directory}@n
/// ファイルの拡張子：@fileinfo{extension}@n
/// ファイル名 (拡張子あり)：@fileinfo{filename}@n
/// 省略：@fileinfo@n
/// フルパス名：@fileinfo{full}@n
/// ファイル名 (拡張子なし)：@fileinfo{name}@n
/// 行番号：@lineinfo

【HTML出力例】

行番号：2
ファイル名 (インライン)
ファイルのディレクトリ：C:/～
ファイルの拡張子：cpp
ファイル名 (拡張子あり)：ver-1-9-5.cpp
省略：ver-1-9-5.cpp
フルパス名：C:/～/ver-1-9-5.cpp
ファイル名 (拡張子なし)：ver-1-9-5
行番号：10

@namespace【名前空間】

メモ

概要

  • 名前空間を記述
  • 定義の直前では、通常は省略 (自動解析)
    その他の位置に記述する場合、必須

関連

外部リンク

構文

@namespace 名前空間名

例

/// @brief 名前空間Ａの概要
/// @details 名前空間Ａの詳細
/// @note @@namespace 省略
namespace NamespaceA
{
}


namespace NamespaceB
{
}
/// @namespace NamespaceB
/// @brief 名前空間Ｂの概要
/// @details 名前空間Ｂの詳細

@includedoc【ファイル挿入 (コマンド有効)】1.8.15下位互換1.11.0

メモ

概要

関連

外部リンク

構文

@includedoc[{オプション}]1.11.0 ファイル名 1.8.15下位互換

{オプション}1.11.0 (コマンド直後に指定)
    {lineno}行番号付き (@includelineno【行番号付きコードブロック (ファイル)】1.8.15下位互換 と同等)
    {local} ローカル環境のクラス・名前空間と見なす
    {doc}省略と同等
    {doc,raise=レベル上げ量} ファイル内 @section【セクション】等の階層を指定量レベル上げ (下位階層へ)
        〔階層レベル：@tableofcontents【ページ内目次作成】参照〕
    {doc,prefix=プレフィックス} ファイル内 @section【セクション】セクション名等の識別名の前に指定プレフィックスを結合

例

/// @includedoc includedoc.txt

【includedoc.txt】

@version 1.2.3
@author 開発者
@copyright 著作権情報

【HTML出力例】

バージョン
1.2.3
著者
開発者
著作権所有
著作権情報

@snippetdoc【ファイル部分挿入 (コマンド有効)】1.8.15下位互換1.11.0

メモ

概要

関連

外部リンク

構文

@snippetdoc[{オプション}]1.11.0 ファイル名 スニペット識別子 1.8.15下位互換

{オプション}1.11.0 (コマンド直後に指定)
    {lineno}行番号付き (@snippetlineno【行番号付きコードブロック (ファイル指定部分)】1.8.15下位互換 と同等)
    {trimleft} 左側余白削除 (TAB_SIZE【タブサイズ】考慮)
    {local} ローカル環境のクラス・名前空間と見なす
    {doc}省略と同等
    {doc,raise=レベル上げ量} ファイル内 @section【セクション】等の階層を指定量レベル上げ (下位階層へ)
        〔階層レベル：@tableofcontents【ページ内目次作成】参照〕
    {doc,prefix=プレフィックス} ファイル内 @section【セクション】セクション名等の識別名の前に指定プレフィックスを結合

※ファイル内の[スニペット識別子]で囲まれた部分が対象

例

/// @snippetdoc snippetdoc.txt SnippetB

【snippetdoc.txt】

[SnippetA]
@version 2.3.4
@author 開発者Ａ
@copyright 著作権情報Ａ
[SnippetA]

[SnippetB]
@version 3.4.5
@author 開発者Ｂ
@copyright 著作権情報Ｂ
[SnippetB]

【HTML出力例】

バージョン
3.4.5
著者
開発者Ｂ
著作権所有
著作権情報Ｂ