c# - XML 文档问题中的泛型

标签 c# xml-documentation

我试图在我的类 XML 文档中包含一个代码片段,但编译器提示 xml 元素未关闭! 这是我想要实现的目标

/// <summary>
/// Method documentation here...
/// </summary>
/// <remarks>
/// <para>
/// This class should be used as follow:
/// <br/>
/// ************** PROBLEM IN NEXT LINE ********************
/// <c> MyClass class = new MyClass<String>(); </c>
/// </para>
/// </remarks>
public class MyClass<T>{
....
}

我试图用 /// <c> MyClass class = new MyClass{String}(); </c> 替换代码片段

有人遇到过这种情况吗?

谢谢你的帮助

最佳答案

在 xml 文档中,您必须将三角括号替换为花括号:

 /// <summary>
 /// Calls <see cref="DoSomething{T}"/>.
 /// </summary>
 public void CallsDoSomething()
 {

 }

 public void DoSomething<T>()
 {

 }

你最终被迫这样做的原因是,如果你允许在元素标记之外使用三角括号,它确实不是格式正确的 xml。

您尝试的替换是正确的。

关于c# - XML 文档问题中的泛型,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/9412865/

相关文章:

vb.net - Xml 文档 <code> 标签显示 C# for VB.NET 代码

c# - 接口(interface)和类方法的注释应该如何不同

c# - 摘要和参数文本的约定?

c# - 为什么++i 和 i++ 都会生成临时文件

c# - 使用静态工厂的替代方法(因为不能有抽象静态方法)

c# - 事务 - 如何避免死锁?

visual-studio-2008 - 如何在 Visual Studio 2008 中为 asp.net 网站生成 xml 文档?

C#/C++ - 如何获取路径太长或权限被拒绝的目录的大小?

c# - Net Core自定义 Controller

delphi - XMLDoc 的 IDE 插件