如何为SomeMethod的Task<SomeClass<SomeOtherClass>>返回类型添加XML注释引用

要给Task<SomeClass<SomeOtherClass>>这种嵌套泛型的返回类型添加准确的XML注释引用，只需要在<see cref=""/>里用大括号{}替代尖括号<>，并直接指定具体的泛型参数即可，具体操作如下：

完整注释示例 #

/// <summary>
/// 自定义的异步方法
/// </summary>
/// <returns>返回一个封装了<see cref="SomeClass{SomeOtherClass}"/>实例的<see cref="Task{TResult}"/></returns>
/// <seealso cref="SomeClass{SomeOtherClass}"/>
public async Task<SomeClass<SomeOtherClass>> SomeMethod()
{ 
    return default;
}

关键说明 #

• XML注释中不允许直接使用尖括号<>，因此引用泛型类型时必须用大括号{}替代
• 对于嵌套泛型（比如Task<SomeClass<SomeOtherClass>>），可以逐层指定具体的泛型参数，文档工具会自动识别对应的类型实例
• <see cref="SomeClass{SomeOtherClass}"/>会精准指向SomeClass<T>绑定SomeOtherClass作为泛型参数的具体类型，无论是在返回值说明还是<seealso>标签里都能正常生效

内容的提问来源于stack exchange，提问作者InquisitiveLad