Al utilizar un ensamblaje externo que viene con un archivo de documentación XML, ¿cómo puedo obtener Visual Studio para encontrarlo?Cómo usar los archivos de documentación XML
Cuando tengo un archivo de documentación XML, ¿hay algún programa o archivo de transformación xml o algo que pueda usar para verlo de una manera agradable? No necesariamente tan complejo como el visor de MSDN la documentación cosita, pero al menos algo mejor que el XML puro ...
1: simplemente se deja caer en la misma carpeta que el archivo DLL
2: ¿necesita ser mantenido? Para el uso "en vivo", tanto VS IDE como "reflector" le permiten revisar la documentación (en contra de los tipos/miembros/etc). Hay herramientas para transformarlo, pero nunca me he molestado. Sandcastle puede valer la pena mirar, pero nunca fue agradable para mí ;-p
respuesta a la primera pregunta: el XML debe tener el mismo nombre que el montaje y ser justo al lado lo. Entonces, si tiene un ensamblado llamado Svish.dll, entonces su archivo de documentación debe ser Svish.xml y debe estar en el mismo directorio.
1) El archivo de documentación debe tener el mismo nombre que el nombre del ensamblado, con la extensión agregada '.xml', y residir en el mismo directorio como su ensamblaje correspondiente. Por ejemplo, tiene un archivo 'MyCompany.MyNamespace.dll' y un archivo 'MyCompany.MyNamespace.dll.xml' en el mismo directorio.
2) NDOC puede generar algunos formatos de documentación dirrent.
En los ejemplos que he visto, y que funcionó para mí, fue como en la respuesta de Marc Gravell. Es decir: 'MyCompany.MyNamespace.xml' no' MyCompany.MyNamespace.dll.xml'. –
En cuanto a 2: Debería poder ver una "versión bonita" de la documentación usando el navegador de objetos (Ver> Examinador de objetos (Ctrl + W)) y luego navegar hacia la clase para revisar la documentación. Utilicé el Examinador de objetos para revisar mi propia documentación, ya que es más amigable para el lector que los archivos xml o los comentarios.
Intenté colocarlo en la misma carpeta, pero parece que no quiere recogerlo. Todavía no recibo documentación. – Svish
Los archivos deben ser Foo.Bar.dll y Foo.Bar.xml (por ejemplo); ¿Estás seguro de que estás haciendo referencia al dll desde esa ubicación? ¿Y estás seguro de que es un archivo de comentarios? –
Parece que tuve que reiniciar VS para que funcione ... ¿hay algún comando para reconstruir/volver a leer la documentación o algo así? – Svish