0
387
ViewsMostrar comentarios en el paquete nuget
¿Cómo incluyo los comentarios que escribo sobre mis métodos y propiedades en mi paquete nuget? Es decir. Entonces, cuando se consume la biblioteca, el usuario puede usar intellisense y leer de qué se trata el método.
p.ej. si tengo el metodo
/// <summary> /// This method does such and such /// </summary> public void SomeMethod() { // does something.. }Luego, quiero que el usuario pueda ver "Este método hace tal y tal cosa" a medida que escriben el método.
2 answers
Answer question0
Para .NET Core y versiones recientes de VisualStudio, al marcar "Archivo de documentación XML" se agregará una ruta absoluta, como se describe aquí . Esto parece ser un error y evita que los paquetes de NuGet incluyan documentación.
La solución es agregar lo siguiente al archivo .csproj y desmarcar la casilla "Archivo de documentación XML".
<PropertyGroup> <GenerateDocumentationFile>true</GenerateDocumentationFile> </PropertyGroup> Recientemente se agregó un destino al SDK , de modo que si este valor es verdadero y DocumentationFile está vacío (es decir, la casilla de verificación no está configurada en Visual Studio), simplemente "hará lo correcto" y generará el archivo de documentación en la salida. carpeta que espera NuGet.
Actualmente no hay forma de hacer esto desde la interfaz de usuario de Visual Studio; una solicitud para hacer ese cambio todavía se está discutiendo al momento de escribir este artículo.
Actualización: parece que la configuración para esto ahora está disponible como una función de vista previa en Visual Studio.
