.net - オブジェクト ブラウザでサポートされている XML コメント タグ

Question

コード サンプルなどを使用してクラス レベル (この場合は実際には ) でより詳細なレベルを提供したいのですがModule、さまざまなタグを機能させるのに苦労しています。

''' <summary>
''' Here's a summary of <c>SmallCodeChunk</c>
''' </summary>
''' <example>
'''   Mmm, Skynet?
'''   <code>
'''      code.CodingItself("that's so meta!")
'''   </code>
''' </example>
''' <remarks>
'''   <para>Unit testable by replacing the <see cref="Implementation"/> property 
'''         with a mocked/stubbed <see cref="IThingy"/>.
'''   </para>
'''   <para>Paragraph of a bunch of stuff. <c>Y</c> is used for <c>True</c> just
'''         for the sake of making the universe a (not) better place.
'''   </para>
''' </remarks>

使用されているタグの一部 ( など) はおそらく実際には有効ではないことに気付きましたが、 の<exception>ようなことができるはずだと思われます<example>。<c>そして、タグにはある種のフォーマット (等幅フォントでしょうか?) が必要だと思います。

間違いがなければ、オブジェクト ブラウザでの表示がサポートされている XML doc タグのサブセットはありますか?

Answer 1

MSDN Magazine の 2009 年の記事によると:

オブジェクト ブラウザには、、、、、、およびコメントが存在する場合に表示summaryされます。paramreturnremarkstypeparamexception

MSDN ブログの2006 年の投稿では、そのリストにseeとが追加seealsoされています。

Answer 2

使用する「推奨」タグのリストは次のとおりです: http://msdn.microsoft.com/en-us/library/ms172653(v=vs.80).aspx

要するに、それらは次のとおりです。

<c>
<code>
<example>
<exception> *
<include> *
<list>
<para>
<param> *
<paramref>
<permission> *
<remarks>
<returns>
<see> *
<seealso> *
<summary>
<typeparam> *
<value>

「*」は、コンパイラが構文を検証するタグを示します。そして、ここにいくつかの追加のハウツーと例を含む短い記事があります:

http://msdn.microsoft.com/en-us/magazine/dd722812.aspx