2013-06-05 111 views
4

我想在代碼示例等級的課程級別(本例中實際上是Module)提供更高級別的詳細信息,但我無法獲取各種標籤工作。對象瀏覽器支持哪些XML註釋標記

''' <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文檔標籤支持在對象瀏覽器中顯示?

回答

1

這裏是「推薦」標籤的列表中使用: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

+0

這並不完全回答我在Visual Studio 2010的對象瀏覽器中哪些標籤有效和受到尊重的問題。 –