Comentarios XML <> lista no se muestra en IntelliSense
-
20-09-2019 - |
Pregunta
Estoy tratando de conseguir VB.NET XML Comentarios para trabajar con IntelliSense , y tal vez no funciona de la manera que creo que sí.
''' <summary>
''' Gets or sets the Patient Code.
''' <list type="bullet">
''' <listheader><description>Validation:</description></listheader>
''' <item><description>Field Required</description></item>
''' <item><description>Field Max Length: 25</description></item>
''' </list>
''' </summary>
''' <value>The region reference key.</value>
Esto debería, cuando se está escribiendo en una función, mostrar la "GET o establece el código del paciente", entonces por debajo de eso, debería mostrar una lista de elementos con viñetas con "Validación:" ¿como el encabezado
alt text http://www.codejames.com/errored.jpg
Tal vez estoy haciendo mal, pero no parece estar funcionando correctamente.
Solución
Usted no está haciendo esto de forma incorrecta, es simplemente no es compatible. Mientras que las marcas HTML pueden aparecer en la salida de algunas herramientas, IntelliSense no es uno de ellos.
IntelliSense es una pantalla de texto en Visual Studio 2008 y no soporta el mostrado que muchos / la mayoría de las marcas, ya que deben aparecer en una pantalla de estilo HTML. En su lugar tenemos la tendencia que se deben eliminar las etiquetas de marcado que no son compatibles y visualizar el texto resultante.
Otros consejos
Puede "falso" que (sin los números) que rodea por el contenido <description>
con la etiqueta <para>
-. Esto por lo menos aparecer en Intellisense bien espaciadas, pero sin el delimitador lista correspondiente (de bola, número)
<summary>
Gets or sets the Patient Code.
<list type="bullet">
<listheader><description>Validation:</description></listheader>
<item><description>Field Required</description></item>
<item><description>Field Max Length: 25</description></item>
</list>
</summary>
<value>The region reference key.</value>
Si no le importa casi nada acerca de la salida generada, basta con añadir su bala en cada línea:
<item><description><para>* Field Required</para></description></item>
Actualizar
Desde la publicación de este, VS2012 11.0.60610.01 Actualización 3 parece haber añadido soporte de formato, por lo que ya no necesita la envoltura interna <para>
o añadir sus propias balas.