如何将代码示例放在XML注释中？

Question

我有这样的XML评论。

/// <summary>
/// Lorem ipsum
/// </summary>
/// <param name="entity"></param>
/// <returns></returns>

我想在其中放置一条（多行）代码。我怎么能这样做？

修改

以下是有关多行代码Adding line breaks to comments for Intellisense

的信息

Answer 1

您可以使用<code>和<c> XML标记

/// <summary>
/// ...
/// <c>Place your code here</c>
/// </summary>
/// <code>
/// More code here
/// </code>

根据<summary>，<summary>您可以使用<c>代码，{{1}}代之外，您可以使用<code>代码。

Answer 2

要添加示例，请使用

<example> 
<code>
Put your example here.
</code>
</example>

标记。

Answer 3

请参阅MSDN：

• XML Documentation Comments (C# Programming Guide)
• Recommended Tags for Documentation Comments (C# Programming Guide)

但是应该注意，XML文档注释只是-XML-并且编译器将处理任何有效的XML标记：它的语义取决于您的documentation processor。< / p>

ECMA 334: C# Language Specification又名ISO 23270: Information technology — Programming languages — C#的附件E指定了一套标准的XML文档标记。

Answer 4

我不完全确定你在问什么，但这是我最好的镜头：

我通常将代码示例放在<example> </example>标记内。

/// <summary>
/// Lorem ipsum
/// </summary>
/// <example>
///    Put you're example here.
/// </example>
/// <param name="entity"></param>
/// <returns></returns>