如何添加＆lt;所包含的项目＆GT;文档评论

Question

我正在尝试编写文档注释但是我遇到了问题。

/// <summary>
/// Inserts an element into the System.Collections.Generic.List<T> at the specified
/// index.
/// </summary>

当我到达<T> Visual工作室时，我认为我正在尝试添加另一个标签。添加这样的评论的正确方法是什么（如果我可以在生成的帮助文本中点击它们，这将是一个额外的奖励）

Answer 1

C＃文档评论是XML，因此将您的<和>更改为<和>。

尽管如此，您最好使用<see>标记插入超链接。在<see>代码中，将<T>更改为{T}：

/// <summary>
/// Inserts an element into the <see cref="List{T}"/> at the specified
/// index.
/// </summary>

（请注意，cref属性由编译器进行语法检查，与普通文本不同。）

Answer 2

转义xml实体。

Change <T> into &lt;T&gt;

Answer 3

我相信这会对你有所帮助：C# XML documentation comments FAQ。

Answer 4

由于注释是xml，因此可以对xml使用适当的转义序列：

/// Inserts an element into the System.Collections.Generic.List<T> at the specified 

Answer 5

您需要使用正确的字符代码：&lt;和&gt;。

你想要在<see cref="..."/>标签中找到整个 System.Collections.Generic.List＆lt; T＆gt; 。

我实际上必须使用上面提到的标签才能正确地写出这个答案：）