XML文档问题中的generics
我试图在我的类XML文档中包含一个代码片段,但编译器抱怨xml元素没有关闭! 这是我想要实现的目标
/// /// Method documentation here... /// /// /// /// This class should be used as follow: ///
/// ************** PROBLEM IN NEXT LINE ******************** /// MyClass class = new MyClass(); /// /// public class MyClass{ .... }
我试图用/// MyClass class = new MyClass{String}();
替换代码片段/// MyClass class = new MyClass{String}();
/// MyClass class = new MyClass{String}();
以前有人经历过这个吗?
谢谢你的帮助
在xml文档中,您必须用花括号替换三角形括号:
/// /// Calls . /// public void CallsDoSomething() { } public void DoSomething() { }
你最终被迫这样做的原因,因为如果你允许在元素标记之外的三角括号,它真的不是很好的形成xml。
你试过的替换是正确的。
你没有关闭第4行中的Remarks
元素,它可能会抱怨,只是在错误的行号。
此外,对于包含generics的示例,它将List
作为文本文本List
后跟未闭合的string
XML元素。 最简单的方法是做List <string&gr;
解析时生成List
而不是XML元素。
C#编译器团队添加了{
和}
作为替换,所以你可以只做List{string}
,它将被处理成<>。
有几件事:
- 通过用
<
替换它们来逃避<
和>
字符<
和>
。 - 使用
关闭XML
部分 - 当您决定在标记中引用generics(即
,
等)时,您将按以下方式执行:
。 永远不要在引用中指定具体类型(即,不要执行
)。
以下是XML注释的固定版本:
/// /// Method documentation here... /// /// /// /// This class should be used as follow: /// MyClass class = new MyClass<string<(); /// /// public class MyClass { .... }
您的
永远不会关闭。
也需要像你已经尝试过的那样更换角度支架。