|
|
|
|
- Presentación
- Documentación automática
- Ajustes
- ¿Qué se incluye en los comentarios?
- Observación: borrado de parámetros
- Entrada predictiva
- Entrada asistida en los procedimientos y métodos de la clase
automatic documentación de procedimientos y métodos
Para simplificar el mantenimiento o el uso del código existente por parte de otros desarrolladores, WINDEV, WEBDEV y WINDEV Mobile proponen una documentación automatic para los procedimientos (o métodos de clase). Esta documentación de automatic corresponde a un set de comentarios. Estos comentarios se generan: - Cuando se crea una nueva Procedure o método.
Puede elegir si desea generar comentarios en la ventana que se muestra al crear un procedimiento o método (opción "Generar un comentario de encabezado"). Los comentarios generados se ajustarán a la Parámetros de la documentación de automatic. - A través de
(que se encuentra en la esquina superior derecha de la ventana de código de Procedure). Este icono se utiliza para generar o eliminar un conjunto de comentarios para la actual Procedure.
También es posible: - Sincronizar automáticamente los comentarios generados según la sintaxis de los procedimientos. Modificando la sintaxis se actualizan automáticamente los comentarios de associated (durante la copia de seguridad).
- Utilizar la entrada asistida al escribir la llamada a los procedimientos o métodos documentados.. Para obtener más información, consulte Entrada predictiva.
Ajustes Para configurar la documentación de automatic: - En la pestaña "Inicio", en el grupo "Entorno", despliegue "Opciones" y seleccione "Opciones del editor de código".
- Visualice la pestaña "Doc.
Importante: Cada bloque de comentarios debe cumplir con el formato que se presenta a continuación. Especialmente, la description de cada parámetro así como la description de valor de retorno debe hacerse en una sola Line. De lo contrario, pueden aparecer desviaciones. ¿Qué se incluye en los comentarios? Los comentarios de una función o Procedure pueden contener los siguientes elementos: - Resumen: la correspondiente comment es la siguiente:
- Encabezado para describir el Procedure: la correspondiente comment es la siguiente:
- Sintaxis de llamada: la correspondiente comment es la siguiente:
- Detalles de los parámetros: el comment correspondiente es el siguiente:
- automatic timer: el comentario correspondiente se utiliza para describir el temporizador automatic definido para la función o para el Procedure:
- Gestión automática de errores y excepciones: la comment correspondiente se utiliza para describir el modo de gestión de los errores y excepciones (definido mediante el enlace "Si error" de la barra de encabezamiento de Procedure). Por ejemplo:
- Observación: el comment correspondiente es el siguiente:
- Ejemplo: el comment correspondiente es el siguiente:
- Marca que indica que el procedimiento debe documentarse: el comment correspondiente es el siguiente:
Observación: borrado de parámetros Si se especifica un parámetro en la sintaxis Procedure, si se elimina, el reference al parámetro sigue siendo Visible en la sección "Detalles de los parámetros" de los comentarios. El texto tecleado por el desarrollador en relación con el parámetro debe ser borrado manualmente por el desarrollador (limita los riesgos de borrado por "error"). La opción "Sincronizar los comentarios con la sintaxis de los procedimientos" sirve para mantener actualizados los comentarios independientemente de las modificaciones realizadas. Entrada asistida en los procedimientos y métodos de la clase Si los parámetros de un procedimiento han sido documentados y si la entrada asistida está disponible en el editor de código, al escribir la llamada al procedimiento, la sintaxis y la description de los parámetros se muestran en un tooltip. Por ejemplo: - Documentación de la Procedure
- Aportación asistida en la Procedure
El mecanismo de entrada asistida para los procedimientos y métodos es idéntico al mecanismo utilizado para las funciones de WLanguage.. Para más detalles sobre los parámetros de entrada asistida en WINDEV, WEBDEV o WINDEV Mobile, véase Entrada asistida para las funciones WLanguage.
Esta página también está disponible para…
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|