Suponga que tiene una biblioteca de C# con varias funciones, todo documentado con el habitual /// <summary>
llenado muy bien. Hacer referencia al proyecto hará que la función y la descripción del parámetro aparezcan en la ayuda contextual de Visual Studio. Pero, ¿es posible tener este programa si no hace referencia al proyecto en sí, solo una compilación (y potencialmente algún otro archivo que tenga la documentación dentro)?¿Cómo se obtiene la documentación XML para mostrar para una biblioteca de C referenciada?
7
A
Respuesta
13
Sí existe - la biblioteca tiene que ser construido con el "archivo XML Documentación" Tickbox marcada (en las páginas de propiedades del proyecto)
Con esta opción cumplía el proceso de construcción ahora construirá una archivo XML adicional en el directorio de salida que contiene toda la documentación XML - cada vez que Visual Studio hace referencia a un conjunto de archivos que va a cargar y mostrar la documentación intelisense de este archivo XML (si se puede encontrar).
Debe distribuir este archivo junto (en el mismo directorio que) su biblioteca compilada.
Cuestiones relacionadas
- 1. XSD para documentación XML generada para C#?
- 2. Biblioteca XML-RPC para C++
- 3. C# XML Documentación Enlace web
- 4. Cómo localizar la documentación de una biblioteca .NET
- 5. Documentación de Javadoc para comentarios XML de C#
- 6. Biblioteca C++ para almacenar configuraciones en XML
- 7. Atributos y documentación XML para método/propiedad
- 8. XML Documentación para las propiedades de dependencia
- 9. ¿Cómo se obtiene Show para el tipo definido en la biblioteca de otra persona?
- 10. Graphviz para la documentación
- 11. Visual Studio IntelliSense para de CREF en la documentación XML
- 12. ¿Cómo se incluyen Xml Docs para una biblioteca de clases en un paquete NuGet?
- 13. Cómo analizar una cadena XML en lugar de XML en c utilizando la biblioteca libxml2
- 14. biblioteca C++ para XMLRPC
- 15. ¿Dónde puedo encontrar documentación para RDLC xml?
- 16. ¿Existen guías de estilo publicadas para la documentación de C# XML?
- 17. Cómo formatear la documentación de Visual Studio XML para visualizarla en la web
- 18. Documentación-generador para Objective-C?
- 19. Estructura de directorios para una biblioteca C++
- 20. Cómo rótulo de código en C# documentación XML
- 21. ¿Cómo ignorar una clase al generar documentación XML para un proyecto de Visual Studio?
- 22. Documentación del código de la biblioteca C++/CLI para usar desde C# - ¿las mejores herramientas y prácticas?
- 23. ¿Hay una biblioteca para mostrar un Virtual Human [WPF]
- 24. La mejor biblioteca de serialización XML para una aplicación MFC C++
- 25. ¿Documentación estándar de la biblioteca SBCL?
- 26. ¿Cómo se obtiene System.Web.Script.javascriptSerializer para ignorar una propiedad?
- 27. Genéricos en la documentación XML problema
- 28. C# BinaryReader.Read() obtiene basura para comenzar con
- 29. ¿Cómo se obtiene una gema de rubí en la ruta de inclusión para "requerir"
- 30. Consejos para envolver una biblioteca C en Objective-C