¿Haciendo referencia a un tipo genérico de tipo genérico en la documentación C# XML?

Question

Escribir alguna documentación XML para una clase de ayudante de predicados. Pero no puedo entender que pueda consultar un Expression<Func<T, bool>> sin obtener un error de sintaxis. ¿Es posible? He intentado esto:

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

Pero conseguir una línea roja ondulada bajo {T, bool}}. Esto funciona sin embargo:

<see cref="Expression{TDelegate}"/> 

¿Alguien tiene una pista?

---

Actualización:

La respuesta que se le dio (y acepté) aparentemente funcionaba. Pero ahora he comenzado a recibir muchas advertencias sobre cosas que no puedo resolver. Tengo una clase llamada ExpressionBuilder<T> que funciona con Expression<Func<T, bool>> mucho. Así que, por supuesto, quiero referirme a eso en mis comentarios XML.

me han tratado las dos versiones que conozco:

<see cref="Expression&lt;Func&lt;T, Boolean&gt;&gt;"/> 
<see cref="Expression{Func{T, Boolean}}"/> 

Pero ni trabajo. (Y en la última, ReSharper pone un azul ondulada bajo {T,Boolean}} consigo dos advertencias bajo la compilación de todo el mundo lo he utilizado la cual dice que:

1. comentario XML en 'bla bla' ha CREF Expresión atributo'> 'que no pudieron ser resueltos
2. tipo declaración de parámetros no debe ser un identificador de un tipo. Véase también CS0081 error.

tienen el mismo problema en alguna parte he intentado hacer referencia a Range<Nullable<DateTime>> (Range<DateTime?> tampoco funcionó. Ambos con {} y con < >)

¿No soy yo supone que se refieren a este tipo de medicamentos genéricos?

Answer 1

Parece que no hay forma de referirse a un genérico genérico en la documentación XML, porque en realidad, no hay forma de referirse a un genérico de ningún tipo específico.

Lasse V de Karlsen answer hizo clic para mí:

Si se escribe <see cref="IEnumerable{Int32}" />, el compilador utiliza simplemente "Int32" como nombre de parámetro de tipo, no el argumento de tipo. Escribir <see cref="IEnumerable{HelloWorld}" /> funcionaría igual de bien. Esto tiene sentido porque no hay una página específica en MSDN para "IEnumerable of int" con la que su documentación pueda vincularse.

para documentar su clase correctamente, creo que tendría que escribir algo como:

<summary> 
Returns an <see cref="IEnumerable{T}" /> of <see cref="KeyValuePair{T,U}" /> 
of <see cref="String" />, <see cref="Int32" />. 
</summary> 

espero que les guste el texto.

Answer 2

// Use "&lt;" instead of "<" symbol and "&gt;" instead of ">" symbol. 

// Sample: 

<see cref="Expression&lt;Func&lt;T, bool&gt;&gt;"/> 

Answer 3

¿A qué exactamente te gustaría vincular?

No hay tal cosa en la documentación como Expression<Func<T>>, por lo que, obviamente, un enlace para que eso no funcionaría.

puede vincular a Expression<TDelegate> debido a que existe.

En cuanto a lo que funciona o no, ninguno de los siguientes trabajos en Visual Studio 2008/.NET 3.5 para mí:

/// <see cref="Expression&lt;Func&lt;T&gt;&gt;"/>. 
/// <see cref="Expression{Func{T}}"/>. 

Pero esto funciona:

/// <see cref="Expression{T}"/>. 

lo que al parecer el tipo genérico parámetro no tiene que ser igual que el de la declaración.

Answer 4

Me encuentro con esto ahora, ya que tengo una función que devuelve List<List<byte>>. Sí, es feo, pero no lo escribí. Descargo de responsabilidad estándar, lo sé.

De todos modos, en VS 2017 con R # 2017.1 último, este comentario de documentación ...

<returns><see cref="List{List{Byte}}" /> of split frames</returns> 

... me da un error de sintaxis. Sin embargo, este ...

<returns><see><cref>List{List{byte}}</cref></see> of split frames</returns>

... no lo hace. Eeeenteresting.

¿Todavía feo? Sí.

Como ugly? Creo que es menos horrible que usar < y > yo mismo ....

Answer 5

No utilice un elemento de ver vacío (<see cref="..." />). En su lugar, ponga texto dentro del elemento see

<see cref="IEnumerable{T}">IEnumerable</see>&lt;<see cref="..."/>$gt;