• Miércoles 20 de Noviembre de 2024, 18:36

Autor Tema:  Documentación Con Xml  (Leído 1105 veces)

julianmj

  • Nuevo Miembro
  • *
  • Mensajes: 22
    • Ver Perfil
Documentación Con Xml
« en: Jueves 10 de Mayo de 2007, 17:39 »
0
Hola a todos, quisiera saber como debo construir la documentación con XML de un proyecto tipo Class Library o cualquier otro en C#, para que al agregarlo como referencia a otro proyecto el IntelliSense® de VS 2005  reconozca mi documentación?

He leido que puede quedar exactamente como la de los namespaces de .NET, ¿Si es posible?

Gracias

julianmj

  • Nuevo Miembro
  • *
  • Mensajes: 22
    • Ver Perfil
Re: Documentación Con Xml
« Respuesta #1 en: Viernes 11 de Mayo de 2007, 00:00 »
0
Hola, ya encontré la respuesta, solo es necesario utilizar las etiquetas definidas para documentar, las cuales se pueden encontrar en msdn2.microsoft.com/en-us/library/5ast78ax(VS.80).aspx y en este otro grandioso articulo www.codeproject.com/csharp/csharpcodedocumentation.asp.

Si estamos en VS 2005 entramos en el explorador de soluciones y luego a
Properties -> Build, habilitamos "XML Documentation File", y luego Generamos el proyecto.

Si entramos a la carpeta del proyecto y luego a la carpeta Debug (la carpeta por defecto) encontraremos el archivo XML con toda la documentación. Ahora podemos mover el DLL a donde queramos siempre acompañado del archivo XML.

Entonces siempre que hagamos un referencia al DLL creado el IntelliSense detectará el archivo XML y mostrara la documentación tal como si fuera la documentación  propia de .NET, eso si utilizamos las etiquetas correctamente.

Si queremos generar un archivo de ayuda podemos utilizar NDoc Alpha y otras aplicaciones existentes para generar ayudas y documentos a partir del archivo XML.

Espero que esto sea de alguna utilidad

Suerte.

JuanK

  • Miembro de ORO
  • ******
  • Mensajes: 5393
  • Nacionalidad: co
    • Ver Perfil
    • http://juank.io
Re: Documentación Con Xml
« Respuesta #2 en: Viernes 11 de Mayo de 2007, 05:05 »
0
es una forma , pero llevarse el xml no es siempre es un requisito... se puede generar un archivo (cre que una dll)con meta-información desde luego esa información es la documentación del archivo.
[size=109]Juan Carlos Ruiz Pacheco
[/size]
Microsoft Technical Evangelist
@JuanKRuiz
http://juank.io