AYUDA EN LÍNEA
 WINDEVWEBDEV Y WINDEV MOBILE

Ayuda / Desarrollar una aplicación o un sitio web / Componente / Componente externo
  • Presentación
  • ¿Qué comentarios se tienen en cuenta?
  • ¿Cuándo se genera la documentación del componente?
  • ¿Cómo acceder a la documentación del componente?
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReportes y ConsultasCódigo de Usuario (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Código Navegador
WINDEV Mobile
AndroidWidget Android iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Otros
Procedimientos almacenados
Presentación
Los componentes externos deben incluir una documentación técnica.
WINDEV, WEBDEV y WINDEV Mobile le ayudan a crear esta documentación mediante las siguientes opciones:
  • Una presentación general del componente. Esta presentación general puede introducirse al generar el componente.
  • Una documentación técnica generada automáticamente a partir de los comentarios en el código de los elementos del componente.
¿Qué comentarios se tienen en cuenta?
Los siguientes comentarios se tienen en cuenta automáticamente para crear la documentación del componente:
  • Comentarios al inicio de los procedimientos WLanguage.
  • Comentarios al inicio de los siguientes eventos:
    • Código de inicialización de ventanas o páginas,
    • Código de inicialización de reportes,
    • Código de inicialización de clases,
    • Código de inicialización de conjuntos de procedimientos.
¿Cuándo se genera la documentación del componente?
La documentación del componente se crea la primera vez que se genera el componente (ícono en los botones de acceso rápido).
Al generar la documentación:
  • los comentarios en el código se utilizan para crear la documentación.
  • si no se encuentran comentarios en el código, los parámetros de entrada y salida esperados de cada elemento accesible del componente se incluirán automáticamente en la documentación. Los comentarios correspondientes se crean automáticamente en los diferentes elementos.
Observación: La documentación del componente puede regenerarse cada vez que se genera el componente (botón "Regenerar").

Atención: Si utiliza la opción "Regenerar", los cambios realizados en la documentación en el asistente de generación se perderán.
¿Cómo acceder a la documentación del componente?
La presentación general del componente se muestra automáticamente en la ventana de descripción del componente.
La documentación técnica del componente está disponible:
  • al integrar el componente en el proyecto: en la pestaña "Proyecto", en el grupo "Proyecto", despliegue "Importar" y seleccione "Un componente externo".
  • en la descripción de los componentes incluidos en el proyecto.
    En el panel "Explorador de proyectos":
    • En la carpeta "Componentes externos", seleccione el componente externo deseado.
    • Haga clic derecho para abrir el menú contextual y seleccione la opción "Descripción".
    • En la pestaña "Detalles", puede obtener los detalles de la documentación generada.
La documentación específica de un elemento del componente (ventana, etc.) se puede consultar:
  • haciendo doble clic en el elemento deseado en el panel del Explorador de proyectos o presionando F2 en el código del elemento.
  • desde el panel "Explorador de proyectos":
    • Seleccione la carpeta "Componentes externos".
    • Haga clic derecho para abrir el menú contextual.
    • Seleccione la opción "Lista de componentes internos importados al proyecto".
Versión mínima requerida
  • Versión 9
Esta página también está disponible para…
Comentarios
Haga clic en [Agregar] para publicar un comentario

Última modificación: 23/03/2023

Señalar un error o enviar una sugerencia | Ayuda local