Bases de datos de proyectos: Construya su propia documentación para los componentes

En una entrada anterior del blog, le mostramos que la documentación de los métodos ha vuelto al Explorador. ¿Quieres llevar las cosas aún más lejos y utilizarlas como documentación para tus componentes? En esta entrada del blog, le mostraremos cómo hacerlo.

Compartir el código fuente y la documentación

Compartir las fuentes de los componentes con las bases de datos del proyecto es muy fácil(por ejemplo, a través de GitHub). Para explicar cómo utilizarlos, la documentación es esencial. La documentación del Explorador se guarda en archivos Markdown, por lo que puede utilizarla para crear documentación para sus componentes.

Si utilizas GitHub, puedes crear un minisitio para tu documentación. Simplemente crea un archivo README con un enlace a la documentación de cada método. Luego, en la configuración de tu repositorio, activa la página de GitHub.

Ya está.

Componente compilado Y DOCUMENTACIÓN

Cuando construyas tu componente o aplicación compilada con el diálogo «Build Application», la carpeta «Documentation» se copiará automáticamente en la carpeta final del proyecto.

Cuando un desarrollador integra su componente en su base de datos, puede ver directamente la documentación en el Explorador en 4D.