2013年8月8日木曜日

Xmlドキュメントコメント codeタグ

<code>
複数行をコードとして指定する場合に使用します。 説明内のテキストをコードとして指定する場合は、<c> タグを使用します。 <example>タグの中でソースコードを示す時に使用する。

SandCastleがタグを拡張してlanguage、titleなどの属性を指定できるようにしています。

 /// <code language="languageId" title="Optional title">
language="languageId"
title="Optional title"

languageIdはVB.NETやC#なら次のように指定します。
 <code language="vbnet">
 <code language="C#">


Language ID
(大文字小文字は区別されない。カンマで区切られたものは同一の意味になります。)
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")


Webの検索ではlanng属性が多くヒットしますが、Sandcastle Help File Builder(Ver 1.9.7.0)のSandcastle XML Comments Guideでは、langタグよりlanguageタグが推奨されています。

0 件のコメント:

コメントを投稿