10

我有一个这样的 XML 注释。

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

我想在其中放置一段（多行）代码。我怎样才能做到这一点 ？

编辑

这是有关多行代码的信息 在Intellisense 的注释中添加换行符

4

4 回答 4

13

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

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

根据评论，<summary>您可以在其中使用<c>标签，在外部<summary>您可以使用<code>标签。

于 2012-09-06T16:54:53.360 回答
6

要添加示例，请使用

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

标签。

于 2012-09-06T16:53:03.180 回答
2

见 MSDN：

不过，应该注意的是，XML 文档注释就是 XML，编译器将处理任何有效的 XML 标记：它的语义取决于您的文档处理器。

ECMA 334的附录 E ：C# 语言规范又名ISO 23270：信息技术 — 编程语言 — C#指定了一组标准的 XML 文档标记。

于 2012-09-06T17:12:48.803 回答
0

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

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

/// <summary>
/// Lorem ipsum
/// </summary>
/// <example>
///    Put you're example here.
/// </example>
/// <param name="entity"></param>
/// <returns></returns>
于 2012-09-06T16:59:18.067 回答