如何在xml文档中引用泛型类和方法

编写可以使用的xml文档时something,当然可以使用.但是,如何引用具有泛型类型的类或方法？

public class FancyClass
{
  public string FancyMethod(T value) { return "something fancy"; }
}

如果我要在某处写xml文档,我将如何引用这个花哨的类？我该如何参考FancyClass？方法怎么样？

例如,在另一个类中,我想让用户知道我将返回一个实例FancyClass.我怎么能看到cref的东西呢？

要参考方法:

///  for more information.

/// 
Uses a  instance.

顺便说一句,它出现在.Net Framework 2.0和3.0的MSDN文档中,但它在版本3.5中消失了

"我怎么参考FancyClass？"

   /// 

"怎么样FancyClass.FancyMethod(T value)？"

   /// 

"我怎么能参考FancyClass？"

   /// 
   ///  whose generic type argument is 

尽管你可以参考其签名的方法包括FancyClass(例如,作为参数类型),则不能直接引用这样的封闭的通用类型.第二个例子解决了这个限制.(例如,在静态System.String.Concat(IEnumerable)方法的MSDN refence页面上可以看到这一点).:

用大括号括起泛型类型参数列表{}而不是<>尖括号.这使您免于逃避后者,<并且>- 记住,文档注释是XML!

如果包含前缀(例如,T:对于类型,M:对于方法,P:对于属性,F:对于字段),编译器将不会对引用执行任何验证,而只是将cref属性值直接复制到文档XML输出.因此,您必须使用适用于此类文件的特殊"ID字符串"语法:始终使用完全限定标识符,并使用反引号来引用泛型类型参数(`n类型,``n方法).

如果省略前缀,则应用常规语言命名规则:您可以删除具有using语句的命名空间,并且可以使用语言的类型关键字,int而不是System.Int32.此外,编译器将检查引用的正确性.

XML文档评论cref备忘单:

namespace X
{
    using System;

    ///   (or  from outside X)
    /// 
    interface I1
    {
        ///   (or  from inside I1)
        /// 
        void M1(int p);

        /// 
        /// 
        void M2(U p);

        /// 
        /// 
        void M3(Action p);
    }

    /// 
    /// 
    interface I2
    {
        /// 
        /// 
        void M1(int p);

        /// 
        /// 
        void M2(T p);

        /// 
        /// 
        void M3(U p);
    }
}

namespace Test
{
    public class FancyClass
    {
        public void FancyMethod(A a, B b, C c, D d, E e) { }
    }
}

namespace Test
{
    public class FancyClass
    {
        ///
        public string FancyMethod(T value) { return "something fancy"; }
    }

    public class Test
    {
        public static void Main(string[] args) { }
    }
}

    
        Test
    
    
        

        
    

///  for more information.

///  for more information.