Comentario de código xml c # para referencia de archivo

Question

¿Existe una etiqueta para una referencia de archivo en un comentario de código xml?El archivo es un archivo de script sql. Me pregunto si hay una forma mejor que algo como esto

///<summary>
///please have a look at c:\code\project1\sql\file1.sql
///</summary> 

Answer 1

Puede usar un URI de archivo, esto hace que se pueda hacer clic en Visual Studio:

file:///c:/code/project1/sql/file1.sql

Answer 2

Puede mezclar elementos de otros espacios de nombres, incluido xhtml, por lo que

///<summary>
///please have a look at <a href="file:///c:/code/project1/sql/file1.sql">file:///c:/code/project1/sql/file1.sql</a>.
///</summary>

Está permitido, aunque si se hace bien o no depende de lo que uses para convertir el XML en algo más legible.El uso de información sobre herramientas al menos en mi IDE ignora la etiqueta y muestra el texto en su interior (que es lo que me gustaría en una información sobre herramientas).

Por supuesto, no es de mucha utilidad en una máquina que no tiene el c: \ code \ project1 \ sql \ file1.sql correcto

Answer 3

Las etiquetas más utilizadas se enumeran en http://msdn.microsoft.com/en-us/library/5ast78ax (v= frente a 71) .aspx .También menciona que procesará "cualquier etiqueta que sea XML válida", por lo que no se limita a estos.

Answer 4

Hay cosas como una etiqueta especial para la referencia de archivo en XML.Es un lenguaje meta sin tales limitaciones.