c# - 到 C# XML 文档中另一个类的参数

Question

有没有办法引用另一个类的泛型参数？我知道我可以使用 <typeparamref> 对当前类(class)执行此操作.

一个例子是编写异步方法的文档。这些返回任务和人们通常需要引用 TResult。查看 this 上的“返回值”页面，例如。他们使用了 <paramref>这显然没有起到作用。

    /// <returns>
    /// A task that represents the asynchronous create operation.
    /// The value of the <paramref name="TResult"/> parameter contains the number of documents created.
    /// </returns>
    public static async Task<int> CreateDocumentsAsync(string filename)

我应该用什么代替 <paramref> ？

Answer 1

我不太明白您的问题，因此我将发布几个示例，这些示例可能会帮助您了解 XML 文档中的泛型。

/// <summary>
/// 
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="obj"></param>
private void IDoSomething<T>(T obj)
{

}

/// <summary>
/// See type <see cref="T:My.Namespace.MyObject"/>
/// </summary>
private MyObject MyObj;

public class MyObject
{

}