2009-07-04 13 views
7

Estoy escribiendo un analizador HTML en C# y quiero incluir ejemplos del HTML que maneja en los bloques XML de resumen. ¿Cómo evito que los caracteres < y> estropeen la auto-documentación de Visual Studio 2008?¿Cómo incluyo una etiqueta html en un resumen de C# para que se procese como texto (no analizado como XML)?

ejemplo:

/// <summary> 
    /// Creates a FlowSegment based on an HTML code, i.e. <bold> 
    /// </summary> 
    /// <param name="code"></param> 
    /// <returns></returns> 
    public FlowSegment(string code) 
    { 

Desafortunadamente el ejemplo hace que la punta de la herramienta para este constructor para visualizar (en parte):

XML comment includes invalid XML 

en lugar del comentario de resumen.

¿Cómo puedo escapar de los caracteres < y>?

Respuesta

18

La mejor solución que encontré fue a cambiarlo a fin de sustituir con < &lt; y> con &gt;

como se encuentra en la XML specifications.

Eso hace que el ejemplo mirada como sigue:

/// <summary> 
    /// Creates a FlowSegment based on an HTML code, i.e. &lt;bold&gt; 
    /// </summary> 
    /// <param name="code"></param> 
    /// <returns></returns> 
    public FlowSegment(string code) 
    { 

que hace que el despliegue de la herramienta de punta deseada correctamente.

Cuestiones relacionadas