Documentar un proyecto
En los proyectos aplicación, puede documentar sus métodos así como sus clases, formularios, tablas o campos. La creación de documentación es especialmente apropiada para proyectos desarrollados por varios programadores y, en general, es una buena práctica de programación. La documentación puede contener una descripción de un elemento, así como cualquier información necesaria para entender cómo funciona el elemento en la aplicación.
Los siguientes elementos del proyecto aceptan la documentación:
- Métodos (métodos base, métodos componente, métodos proyecto, métodos formulario, métodos 4D Mobile y triggers)
- Clases
- Formularios
- Tablas y campos
Sus archivos de documentación se escriben en la sintaxis Markdown (archivos .md) utilizando cualquier editor que soporte el Markdown. Se almacenan como archivos independientes dentro de la carpeta Proyecto.
La documentación se muestra en el área de vista previa (panel lateral derecho) del Explorador:
También se puede exponer parcialmente como consejos del editor de código.
Archivos documentación
Nombre del archivo de documentación
Los archivos de documentación tienen el mismo nombre que su elemento adjunto, con la extensión ".md". Por ejemplo, el archivo de documentación adjunto al método proyecto myMethod.4dm
se llamará myMethod.md
.
En el Explorador, 4D muestra automáticamente el archivo de documentación con el mismo nombre que el elemento seleccionado (ver abajo).
Arquitectura de los archivos de documentaci ón
Todos los archivos de documentación se almacenan en la carpeta Documentación
, situada en el primer nivel de la carpeta Package.
La arquitectura de la carpeta Documentation
es la siguiente:
-
Documentation
Clases
- myClass.md
DatabaseMethods
- onStartup.md
- ...
Formularios
- loginDial.md
- ...
Métodos
- myMethod.md
- ...
TableForms
- 1
- input.md
- ...
- ...
- 1
Triggers
- table1.md
- ...
-
Un formulario proyecto y su método de formulario proyecto comparten el mismo archivo de documentación para el formulario y el método.
-
Un formulario tabla y su método de formulario tabla comparten el mismo archivo de documentación para el formulario y el método.
Renombrar o eliminar un elemento documentado en su proyecto también renombrará o eliminará el archivo Markdown asociado al elemento.