C# XML文档中的泛型问题
我试图在我的类XML文档中包含一个代码片段,但是编译器抱怨XML元素没有关闭! 以下是我正在努力实现的目标C# XML文档中的泛型问题,c#,xml-documentation,C#,Xml Documentation,我试图在我的类XML文档中包含一个代码片段,但是编译器抱怨XML元素没有关闭! 以下是我正在努力实现的目标 /// <summary> /// Method documentation here... /// </summary> /// <remarks> /// <para> /// This class should be used as follow: /// <br/> /// ************** PROBLEM I
/// <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>{
....
}
//
///方法文档在这里。。。
///
///
///
///此类应按如下方式使用:
///
///*************下一行有问题********************
///MyClass类=新的MyClass();
///
///
公共类MyClass{
....
}
我试图用///MyClass class=newmyclass{String}()替换代码段代码>
以前有人经历过吗
感谢您在xml文档中提供的帮助,您必须用大括号替换三角形大括号:
/// <summary>
/// Calls <see cref="DoSomething{T}"/>.
/// </summary>
public void CallsDoSomething()
{
}
public void DoSomething<T>()
{
}
//
///电话。
///
public void CallsDoSomething()
{
}
公共无效剂量测定法()
{
}
最终被迫这样做的原因是,如果允许在元素标记之外使用三角括号,那么它实际上不是格式良好的xml
您尝试的替换是正确的。您的
从未关闭
还需要像您已经尝试过的那样更换角括号。您没有关闭第4行中的备注
元素,它可能会抱怨,只是行号不对
此外,对于包含泛型的示例,它选择List
作为文本文本List
,后跟一个未关闭的string
XML元素。最简单的方法是执行List&;书信电报;弦乐;gr代码>解析后生成列表
,而不是XML元素
C#编译器团队添加了{
和}
作为替代,因此您只需执行列出{string}
,它将被处理为的。一些事情:
通过将
和
字符替换为
和
来转义您的
字符
用
当您决定引用标记中的泛型(即
,
等)时,您将按照以下方式执行:
。切勿在引用中指定具体类型(即,不要执行
)
以下是XML注释的固定版本:
/// <summary>
/// Method documentation here...
/// </summary>
/// <remarks>
/// <note type="implementsinfo">
/// <para>This class should be used as follow:</para>
/// <para><c>MyClass class = new MyClass<string<();</c></para>
/// </note>
/// </remarks>
public class MyClass<T>
{
....
}
//
///方法文档在这里。。。
///
///
///
///此类应按如下方式使用:
///MyClass类=新的MyClassstring();
///
///
公共类MyClass
{
....
}
这是在@KAJ上询问和回答的,因为OP更新并更正了一个复制/粘贴错误。我同意并投票决定以重复方式关闭。是的-你也可以这样做-尽管这会使代码文档本身的可读性降低。对不起,这是一个复制/粘贴问题。刚才添加了备注的结束标记。对不起,这是复制/粘贴问题。刚刚添加了备注的结束标记。在这种情况下,KAJ是正确的,使用大括号将解决您的问题。感谢您的快速回复。我将使用{}而不是and