2010-04-20 12 views
11

que tienen un método en un proyecto de C#/WPF y me gustaría comentar/Documento mediante los comentarios XML como estecomentarios Studio XML Visuales (resumen) y caracteres especiales

/// <summary> 
    /// Initialises Drag & Drop 
    /// </summary> 
    void initDragDrop() 
    { 

    } 

Cuando ahora uso este método en algún lugar de mi proyecto y pasando el mouse sobre él, aparece el mensaje "El comentario XML contiene XML no válido: En este lugar, no se permiten espacios" (Traducí el texto después de los dos puntos manualmente al inglés, por lo que no estar literalmente en tu estudio visual). Descubrí que el problema es el signo "&", si lo elimino, funciona bien. Pero quiero conservarlo, entonces, ¿cómo puedo escaparlo en el resumen XML? Intenté "\ &" pero esto no está funcionando.

¡Gracias por cualquier pista!

Respuesta

16

Recuerde que el carácter & tiene un significado especial en xml (el comienzo de una entidad). Es necesario para escribir su comentario como este lugar (molesto, lo sé):

/// <summary> 
/// Initialises Drag &amp; Drop 
/// </summary> 
void initDragDrop() 
{ 

} 

puedo estar equivocado en este punto siguiente, pero no creo que incluso se puede usar una sección CDATA para evitar la entidad, porque rompe los comentarios. Usted debe escribir la entidad &amp; completa.

+1

En realidad, puede usar CDATA. Aquí hay un ejemplo de uno de mis proyectos: http://kbcsv.codeplex.com/sourcecontrol/network/Show?projectName=kbcsv&changeSetId=42031#530479. Otra opción es mover la documentación a un archivo separado y en el archivo de origen. –

+0

Gracias, bueno, sé. –

+0

¡gracias a ambos por sus respuestas! Kent, usando su enlace, he visto que su clase está bien documentada. ¿Supongo que estás generando algo de HTML a partir de esto? ¿Qué herramienta estás usando para esta tarea? La última vez que busqué estas herramientas, todas fueron para versiones anteriores de dot net o difíciles de usar para principiantes. Acepto la respuesta de joels, primero es una solución corta, second kent agregó su solución como comentario que no es marcable, de lo contrario lo marcaría también ;-) –

Cuestiones relacionadas