0
547
Visualizações¿Hay alguna forma de conservar los espacios en blanco en los comentarios XML de C#?
Actualmente estoy documentando mi código C# y me resultaría útil incluir un bloque de código que muestre directamente cómo se debe llamar a un fragmento de código. Uso la etiqueta <code> que está incrustada en el resumen:
Si bien esto funciona en general, me gustaría conservar los espacios en blanco (saltos de línea, sangría). Intenté lo siguiente hasta ahora:
- Apliqué el atributo
xml:space="preserve"a la etiqueta<code>, pero esto no tuvo ningún efecto. -
<br />para indicar nuevas líneas individuales ( esto funciona a partir de VS 2019 ), pero no puedo insertar espacios ni tabulaciones. Traté de usar (para espacio) y	(para la pestaña), pero la ventana emergente no los mostraría. - Traté de usar una sección
CDATA, pero el código intermedio no se mostró en absoluto.
¿Hay alguna forma de conservar los espacios en blanco en las etiquetas de código de los comentarios XML de C#? De forma anticipada, muchas gracias por su ayuda.
1 Respostas
Responde à pergunta0
Su primer comentario de documento XML es correcto. No debe confiar en lo que Intellisense le muestra en la información sobre herramientas. Intellisense no respeta todos los formatos, pero mejora con cada versión de VS.
Las nuevas líneas y los espacios en blanco en una etiqueta <code> son respetados por herramientas que generan documentación a partir de los comentarios XML, como VSdocman (soy el autor) o Sandcastle. Lo mismo se aplica a CDATA. Entonces, si genera, por ejemplo, una documentación HTML a partir de sus comentarios, su bloque de código se verá bien, con todos los espacios en blanco y líneas nuevas.
Si desea verlo correctamente también en Intellisense, debe esperar, o mejor aún, enviar un comentario de Visual Studio al equipo de MS.