Al desarrollar una aplicación, puede ser muy útil tener un acceso rápido a los detalles de un método(por ejemplo, una explicación de lo que hace, su sintaxis y una definición de los parámetros que se le pasan). Esto es aún más importante cuando se utiliza un componente compilado. No se puede ver el contenido del método, así que sólo se puede confiar en su documentación para entender cómo utilizarlo.
El diálogo del Explorador ha sido mejorado y la documentación está ahora disponible en 4D v18 R3 para las bases de datos del proyecto.
La documentación se guarda en un archivo con el mismo nombre que el método o formulario en una carpeta de documentación. El nuevo formato de la documentación es Markdown.
¿Por qué Markdown?
El lenguaje Markdown permite formatear el texto y tiene una sintaxis muy sencilla. Así, el documento es fácil de leer y escribir, sin interrumpir su interpretación.
Muchas herramientas utilizan Markdown para dar formato a la documentación. Por ejemplo, GitHub proporciona un intérprete de Markdown integrado.
Documentación en 4D
La documentación está disponible para:
- Métodos de proyecto
- Métodos de la base de datos
- Métodos de activación
- Métodos de formularios de proyectos
- Métodos del formulario de la tabla
- Clases
Cuando se exporta la base de datos binaria como proyecto, la documentación existente se guarda en archivos con formato Markdown.
Para crear o editar el archivo de documentación de una base de datos de proyecto, haga clic en el botón «Crear» o seleccione la opción de menú «Editar documentación» en el Explorador.
4D crea el archivo correspondiente y lo abre en su editor por defecto. El archivo incluye una plantilla:
<!-- Type your summary here --> ## Description ## Example ```4d Type your example here ```
Puede ver que la primera línea utiliza las etiquetas de comentario HTML. Esta información se muestra en el editor de métodos cuando pasa el cursor por encima del método. El resto del archivo se muestra en la pestaña «Documentación» del explorador.
Ejemplo
Si utilizamos el método getWeekday como ejemplo, este es el resultado:
En una próxima entrada del blog, le mostraremos cómo hacer uso de los comentarios para escribir su propia documentación para los componentes. Mantente atento.