<example>【使用例】
<c>【コード (インライン)】
<code>【コード (行ブロック)】
メモ
<example>【使用例】
- 使用例
- <code>【コード (行ブロック)】でコード記述
<c>【コード (インライン)】
- インラインのコード
- 参照:<code>【コード (行ブロック)】
<code>【コード (行ブロック)】
- 行ブロックのコード
- 通常、<example>【使用例】で使用
- <![CDATA[ と ]]> で囲むと特殊コードもそのまま記述可
- 参照:<c>【コード (インライン)】
構文
<example>【使用例】</example>
<c>【コードテキスト】</c>
<code>【コードテキスト】</code>
<code language="【言語 ID (下記参照)】"
[keepSeeTags="true | false"【see タグの有効無効】]
[numberLines="true | false"【行番号表示有無】]
[outlining="true | false"【アウトライン表示有無】]
[source="【外部ソースコードファイル名】" [region="【読み込みリージョン名】"] [removeRegionMarkers="true | false"【ネストされたリージョンマーカーの削除有無】]]
[tabsize="###"【タブサイズ】]
[title="【タイトル (省略:言語)】"]>
【コードテキスト】
</code>
| 言語 ID | 言語 |
|---|---|
| cs C# CSharp | C# |
| cpp cpp# C++ CPlusPlus | C++ |
| c | C |
| fs f# FSharp fscript | F# |
| EcmaScript js JavaScript | JavaScript |
| jscript jscript# jscriptnet JScript.NET | JScript.NET |
| VB VB# vbnet VB.NET | VB/VB.NET |
| vbs vbscript | VBScript |
| htm html xml xsl | XML |
| XAML | XAML |
| jsharp J# | J# |
| sql sql server sqlserver | SQL script |
| py python | Python |
| pshell powershell ps1 | PowerShell script |
| bat batch | batch file script |
| その他 (例:none) | 未指定 |
外部リンク
- Microsoft Docs (英語)
- Sandcastle Help File Builder (英語)
例
/// <summary>
/// 乗算 (<c>x * y</c>)
/// </summary>
/// <param name="p1">被乗数</param>
/// <param name="p2">乗数</param>
/// <returns>積</returns>
/// <example>
/// <code language="C#" numberLines="true">
/// int ans;
/// ans = Mul(2, 3);
/// </code>
/// </example>
public int Mul(int p1, int p2)
{
return p1 * p2;
}