proyecto - pasos para crear una libreria en c#

¿Es necesario desplegar el archivo XML en una biblioteca de clases?

Question

He desarrollado una gran cantidad de proyectos de bibliotecas de clase en VS 2012 para ser utilizados en aplicaciones de formularios de Windows y formularios web.

La pregunta es simple. ¿Necesito implementar el archivo DLL junto con el archivo XML que se crea?

Por ejemplo, el proyecto de biblioteca de clases se llama DataWare. Al construir, obtuve 5 archivos en la carpeta Release (este proyecto hace referencia a Entity Framework):

• DataWare.dll
• DataWare.pdb
• DataWare.dll.config
• EntityFramework.dll
• EntityFramework.xml

Sé que el archivo ".pdb" contiene información de depuración, por lo que no es necesario implementarlo. El archivo ".config" no se tiene en cuenta. En su lugar, App.config o Web.config son.

Con respecto a esto, creo que tengo que implementar solo DataWare.dll y EntityFramework.dll.

Sin embargo, la duda principal es si también necesito implementar EntityFramework.xml.

Saludos Jaime

Answer 1

El archivo XML contiene los comentarios de documentos para los tipos públicos y miembros en el ensamblaje.

Solo lo necesita si desea que Visual Studio muestre la documentación en IntelliSense.

Si está implementando una aplicación orientada al consumidor (a diferencia de una biblioteca reutilizable que enfrenta el desarrollador), no la necesita.

Answer 2

No, en la mayoría de los casos no lo necesitas. Si hay una DLL externa que debe copiarse localmente y hacer referencia mediante la configuración, es posible que deba hacerlo, pero eso es algo raro.