@a・@e・@em【強調 (イタリック体)】1.13.0
@b【太字】
@c・@p【等幅フォント】1.13.0
@n【改行】
@--【enダッシュ】
@---【emダッシュ】
@.【省略コマンド終了文字エスケープ】
@?・@!【省略コマンド終了文字エスケープ】1.13.0
@@【@ 出力】等 エスケープシーケンス
@emoji【絵文字】1.8.15 / 1.11.0

@a【強調 (イタリック体)】1.13.0
@e【強調 (イタリック体)】
@em【強調 (イタリック体)】

メモ

概要

スタイル【HTML出力】

関連

外部リンク

構文

@a  単語
@e  単語
@em 単語

例

/// The quick brown fox jumps over the lazy dog.@n
/// The @a quick brown fox @e jumps over the @em lazy dog.

【HTML出力例】

The quick brown fox jumps over the lazy dog.
The quick brown fox jumps over the lazy dog.

【ユーザー定義CSS】

/* @a 対応 */
em.arg {
  color: red;
  font-size: large;
  font-weight: bold;
}

【HTML出力例 (CSS指定)】

The quick brown fox jumps over the lazy dog.
The quick brown fox jumps over the lazy dog.

@b【太字】

メモ

構文

@b 単語

例

/// The quick brown @b fox jumps over the lazy @b dog.

【HTML出力例】

The quick brown fox jumps over the lazy dog.

@c【等幅フォント】
@p【等幅フォント】1.13.0

メモ

概要

  • 等幅フォント

スタイル【HTML出力】

関連

外部リンク

構文

@c 単語
@p 単語

例

/// The quick brown fox jumps over the lazy dog.@n
/// The @c quick brown fox jumps over the @p lazy dog.

【HTML出力例】

The quick brown fox jumps over the lazy dog.
The quick brown fox jumps over the lazy dog.

【ユーザー定義CSS】

/* @p 対応 */
code.param {
  color: red;
  font-size: large;
  font-weight: bold;
}

【HTML出力例 (CSS指定)】

The quick brown fox jumps over the lazy dog.
The quick brown fox jumps over the lazy dog.

@n【改行】

メモ

構文

@n

例

/// The quick brown fox @n jumps over @n the lazy dog.

【HTML出力例】

The quick brown fox
jumps over
the lazy dog.

@--【enダッシュ】
@---【emダッシュ】

メモ

構文

@--


@---

@.【省略コマンド終了文字エスケープ】
@?【省略コマンド終了文字エスケープ】1.13.0
@!【省略コマンド終了文字エスケープ】1.13.0

メモ

構文

@ の後の記号をそのまま出力
@.
@? 1.13.0
@! 1.13.0

例 (Javadoc 形式コメント)

JAVADOC_AUTOBRIEF=YES

/**
 * クラス概要Ａ@.
* クラス概要Ｂ.
* 説明Ｃ
 */
class ClassCharacter_javadoc_1
{
};

/**
 * クラス概要Ｄ@?
* クラス概要Ｅ?
* 説明Ｆ
 */
class ClassCharacter_javadoc_2
{
};

/**
 * クラス概要Ｇ@!
* クラス概要Ｈ!
* 説明Ｉ
 */
class ClassCharacter_javadoc_3
{
};

【HTML出力例：該当部分】

詳解

クラス概要Ａ. クラス概要Ｂ.

説明Ｃ


詳解

クラス概要Ｄ? クラス概要Ｅ?

説明Ｆ


詳解

クラス概要Ｇ! クラス概要Ｈ!

説明Ｉ

例 (Qt 形式コメント)

QT_AUTOBRIEF=YES

/*!
 * クラス概要Ａ@.
* クラス概要Ｂ.
* 説明Ｃ
 */
class ClassCharacter_qt_1
{
};

/*!
 * クラス概要Ｄ@?
* クラス概要Ｅ?
* 説明Ｆ
 */
class ClassCharacter_qt_2
{
};

/*!
 * クラス概要Ｇ@!
* クラス概要Ｈ!
* 説明Ｉ
 */
class ClassCharacter_qt_3
{
};

【HTML出力例：該当部分】

詳解

クラス概要Ａ. クラス概要Ｂ.

説明Ｃ


詳解

クラス概要Ｄ? クラス概要Ｅ?

説明Ｆ


詳解

クラス概要Ｇ! クラス概要Ｈ!

説明Ｉ

@@【@ 出力】等 エスケープシーケンス

メモ

構文

@ の後の記号をそのまま出力
@$
@@
@\
@&
@<
@>
@#
@%
@"
@::
@|
@= 1.8.15

例

/// The quick brown <span style="font-size:x-large">fox</span> jumps over the lazy <span style="font-size:x-large">dog</span>.@n
/// The quick brown @<span style@=@"font-size:x-large@"@>fox@</span@> jumps over the lazy @<span style@=@"font-size:x-large@"@>dog@</span@>.

【HTML出力例】

The quick brown fox jumps over the lazy dog.
The quick brown <span style="font-size:x-large">fox</span> jumps over the lazy <span style="font-size:x-large">dog</span>.

@emoji【絵文字】1.8.15 / 1.11.0

メモ

構文

@emoji 絵文字名
@emoji :絵文字名:

絵文字名：GitHubでサポートしている名前 (参照：Complete list of github markdown emoji markup)

例

/// @emoji sunny (sunny)@n
/// @emoji cloud (cloud)@n
/// @emoji umbrella (umbrella)@n
/// @emoji snowman (snowman)@n
/// @n
/// @emoji :house: (:house:)@n
/// @emoji :school: (:school:)@n
/// @emoji :post_office: (:post_office:)@n
/// @emoji :hospital: (:hospital:)@n
/// @emoji :bank: (:bank:)@n
/// @emoji :convenience_store: (:convenience_store:)@n
/// @n
/// @emoji :jp: (:jp:) @n
/// @emoji :japan: (:japan:)@n
/// @emoji :mount_fuji: (:mount_fuji:)@n
/// @emoji :japanese_castle: (:japanese_castle:)@n
/// @emoji :tokyo_tower: (:tokyo_tower:)@n
/// @n
/// @emoji :file_folder: (:file_folder:)@n
/// @emoji :clipboard: (:clipboard:)@n
/// @emoji :bookmark: (:bookmark:)@n
/// @emoji :heavy_check_mark: (:heavy_check_mark:)@n
/// @emoji :red_circle: (:red_circle:)@n
/// @emoji :large_blue_circle: (:large_blue_circle:)

【HTML出力例】

☀ (sunny)
☁ (cloud)
☔ (umbrella)
⛄ (snowman)

🏠 (:house:)
🏫 (:school:)
🏣 (:post_office:)
🏥 (:hospital:)
🏦 (:bank:)
🏪 (:convenience_store:)

🇯🇵 (:jp:)
🗾 (:japan:)
🗻 (:mount_fuji:)
🏯 (:japanese_castle:)
🗼 (:tokyo_tower:)

📁 (:file_folder:)
📋 (:clipboard:)
🔖 (:bookmark:)
✔ (:heavy_check_mark:)
🔴 (:red_circle:)
🔵 (:large_blue_circle:)