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

Traducido automáticamente de Deepl

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.

blank

Ya está.

README.md

blank

getStartOfMonth.md

blank

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.

Proyecto

blank

Componente compilado

blank

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

blank

Vanessa Talbot
• Propietario de producto - Vanessa Talbot llegó al equipo de 4D Program en junio de 2014. Como Propietario de producto, está a cargo de escribir las historias de los usuarios y luego traducirlas a especificaciones funcionales. Su papel es también asegurarse de que la implementación de la funcionalidad entregada cumpla con las necesidades del cliente. Desde su llegada, ha trabajado en la definición de funcionalidades claves en 4D. Ha trabajado en la mayoría de las nuevas funcionalidades de multi hilo apropiativo y también en un tema muy complejo: la nueva arquitectura para la aplicación engined. Vanessa es licenciada por Telecom Saint-Etienne. Comenzó su carrera en el Instituto de Investigación Criminal como desarrolladora del departamento audiovisual. También ha trabajado en medios de comunicación y en el ámbito médico como experta en soporte técnico, producción y documentación de nuevas funcionalidades.