XML Documentation: <see> tag with multiple generic type parameters

瘦欲@ 提交于 2019-12-07 12:31:15

问题


I'm trying to use XML documentation on the members of a class, and in a certain case I would like to reference a generic type using a tag. The problem here is that a warning is generated when multiple generic type parameters are specified. It was easy enough to find how to reference a generic type with a single parameter, as such:

<see cref="Func{int}" />

However, trying something like this generates the warning:

<see cref="Func{int, bool}" />

It seems that I am either using the wrong syntax for references with more than one type parameter, or such references are not currently supported in XML docs for C#. Strangely enough, I can't seem to find any information about this on MSDN or in the Sandcastle docs (which I'm using to compile the documentation, and also complains about the syntax). Any clarification here would be appreciated.


回答1:


Use the .NET names, not the C# aliases:

<see cref="Func{Int32, Boolean}" />


来源:https://stackoverflow.com/questions/526970/xml-documentation-see-tag-with-multiple-generic-type-parameters

易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!