Xmlドキュメントコメントで複数行のソースコードとして指定する場合に使用します。 説明内のテキストをコードとして指定する場合は、<c> タグを使用します。<code>は<example>タグの中でソースコードを示す時に使用します。
Sandcastleで<code>タグを使用する場合は、プログラミング言語を指定するlanguage属性、<code>タグのエリアのタイトルを指定するtitle属性といった拡張属性が使えます。
language属性を指定しない場合の言語はC#となるようです。
/// <code language="languageId" title="Optional title">
language="languageId"
title="Optional title"
language属性はLanguage IDを指定します。title属性はタイトルの文字列を指定します。
cs, C#, CSharp
cpp, cpp#, C++, CPlusPlus
c
fs, f#, FSharp, fscript
EcmaScript, js, JavaScript
jscript, jscript#, jscriptnet, JScript.NET
VB, VB#, vbnet, VB.NET
vbs, vbscript
htm, html, xml, xsl
XAML
jsharp, J#
sql, sql server, sqlserver
pshell, powershell, ps1
py, python
Anything else (i.e. "none")
※カンマで区切られたものは同一の意味になります。
※Language IDは大文字小文字は区別しません。
※Sandcastle Help File Builder(Ver 1.9.7.0)のSandcastle XML Comments Guideでは、lang属性よりlanguage属性が推奨されています。
0 件のコメント:
コメントを投稿