Utilizar los comentarios

El Explorador le permite asociar comentarios a los objetos de su base de datos. El uso de comentarios es especialmente apropiado para bases desarrolladas por varios programadores y generalmente es una buena práctica de programación. Sus comentarios son visibles en el área de vista previa del Explorador.

Los siguientes tipos de objetos aceptan el uso de comentarios:

• carpetas
• métodos (base, componentes, proyecto, triggers y formulario),
• formularios,
• tablas,
• campos,
• plug-ins

Un comentario 4D se presenta como texto, (los caracteres pueden tener diferentes estilos de fuentes o colores, etc.) modificable y visualizable en cualquier momento en el entorno Explorador. Puede contener una descripción del objeto al que está asociado, así como también toda la información necesaria para entender el funcionamiento de la base. Los comentarios se guardan en la estructura de la base.

Adicionalmente, puede generar comentarios automáticos, es decir cuyo contenido es actualizado automáticamente por 4D cuando un objeto se crea o modifica.

Nota de compatibilidad: desde la versión 12 de 4D, los comentarios insertados en el encabezado de un método utilizando los caracteres // se muestran como mensajes de ayuda cuando el método es referenciado en otro método (ver el párrafo "Utilizar los mensajes de ayuda" en la sección WA SET EXTERNAL LINKS FILTERS. Esta función, muy útil para documentar los métodos usuario, no es compatible con los comentarios en el Explorador. Si quiere utilizar los encabezados de los métodos en esta forma, no introduzca comentarios en el Explorador.

Puede crear, ver y modificar comentarios desde el Explorador. Para añadir un comentario cuando se muestra el área de vista previa, seleccione el objeto en la lista del Explorador y luego haga clic en el botón Comentarios ubicado en la parte inferior del área vista previa.

Cuando la opción Comentarios está seleccionada, el área de vista previa es reemplazada por el área Comentarios y puede introducir o modificar el texto mostrado.

4D Server: el icono de bloqueo, ubicado en la esquina inferior izquierda del área, indica si el comentario está siendo editado por otro usuario. Si ese es el caso, el lápiz aparece con una barra diagonal y sólo se puede ver el comentario.

El texto se guarda tan pronto como hace clic fuera del área de entrada. Puede introducir hasta 32 700 caracteres de comentarios por objeto.
Puede utilizar en el área de comentarios los comandos estándar de edición de texto (Copiar, Pegar, Seleccionar todo, etc.) disponibles en el menú contextual o utilizando los atajos de teclado. También puede utilizar las teclas de navegación para desplazarse por el texto en el área de comentarios.

Puede enriquecer el estilo de los comentarios (colocando negrita o itálica) y cambiar la fuente de los caracteres o su color:

1. Seleccione el texto que quiere modificar en el área Comentarios.
2. Haga clic derecho en el área.
   Aparece un menú jerárquico desplegable:
   
3. Seleccione los atributos que quiere aplicar al texto.

Es posible activar un sistema de comentarios automáticos, sólo para los métodos y formularios de la base de datos. Cuando este sistema está activo, un comentario se asocia automáticamente a cada método o formulario creado o modificado en la base. Un comentario automático puede contener texto estático (como “Modificado por”) y elementos variables (fecha, hora y usuario actual tal como están definidos en la tabla de contraseñas de 4D).

Los comentarios automáticos se definen en la caja de diálogo de Propiedades de la base, Página General (ver el párrafo ). Al igual que los comentarios estándar, usted puede verlos en el Explorador. 

Para activar el sistema de comentarios automáticos:

1. Muestre la caja de diálogo de Propiedades vía el comando Propiedades de la base... del menú Diseño o haciendo clic en el botón Propiedades de la barra de herramientas de 4D.
2. En la página General, seleccione la opción Activar los comentarios auto. 
3. Introduzca el texto de los comentarios.
   Puede insertar textos estáticos y elementos variables utilizando los botones Fecha, Hora y Usuario ubicados en el área. También puede introducir directamente las siguientes variables:
   #D para la fecha
   #H para la hora
   #N para el usuario actual

Por ejemplo, si introduce los siguientes valores:

El comentario automático se añadirá a los comentarios para todos los nuevos métodos y formularios, como también para todos los métodos y formularios existentes que se modifican dos después de que se activan los comentarios automáticos:

Nota: si la base no tiene un sistema de contraseñas, #N devuelve la cadena “Diseñador.”

4D Server: los comentarios automáticos pueden ser modificados por todo equipo cliente con acceso a las Propiedades de la base. También puede modificar estos parámetros en las Propiedades de la base en el equipo servidor. Toda modificación efectuada en la página de comentarios automáticos es tenida en cuenta de inmediato por cada equipo cliente tan pronto como se modifica un objeto comentado.