Visual Studio文档注释<returns>标签泛型类型XML报错解决方案咨询
解决XML注释中泛型类型引发的格式警告问题
遇到这种情况是因为XML解析器把泛型的>当成了<returns>标签的结束符,有两种靠谱的解决办法:
使用HTML实体转义
把泛型里的>替换成HTML实体>,这样XML解析器就不会误判了。示例代码:/// <summary>获取客户列表</summary> /// <returns>返回类型为List<Customer></returns> public List<Customer> GetCustomers() { // 方法实现 }使用
<see cref=""/>标签引用类型
这种方式更符合XML注释的规范,还能在Visual Studio里点击跳转至类型定义,同时避免格式问题。注意泛型类型的尖括号要换成大括号:/// <summary>获取客户列表</summary> /// <returns>返回类型为<see cref="List{Customer}"/></returns> public List<Customer> GetCustomers() { // 方法实现 }
内容的提问来源于stack exchange,提问作者Sam
相关产品推荐
相关产品推荐

