Cómo utilizar #if en un comentario XML.
Pregunta
Estoy escribiendo una biblioteca con código fuente común para el servidor y el cliente.
El problema está dentro de los comentarios XML, donde a veces la documentación del cliente y del servidor difiere, algo como esto:
/// <summary>
/// Hace algo.
/// </summary>
/// <remarks>
/// Información común.
<h1>si el Cliente</h1>
/// Información adicional solo para el cliente.
<h1>fin si</h1>
/// </remarks>
<code>
Cuando compilo sin el símbolo `Cliente` definido, tengo la siguiente advertencia:
</code>
Advertencia CS1570: El comentario XML tiene un XML mal formado - Se esperaba una etiqueta de cierre para el elemento 'remarks'.
CS1570: El comentario XML tiene un XML mal formado - La etiqueta de cierre no se esperaba en esta ubicación.
Advertencia CS1587: El comentario XML no se coloca en un elemento de lenguaje válido
¿Existe alguna solución para esto o no hay esperanza?
davy.ai
Sí, hay una solución para esto. Puede utilizar la directiva
#pragma warning disablepara suprimir la advertencia. Por ejemplo, puede agregar la siguiente línea de código antes del comentario XML:c##pragma warning disable 1570, 1587
Esto suprimirá las advertencias para el comentario XML.