Comentarios

Q-SYS Control 101 Training (Spanish) : Fundamentos de Scripting

3 ) Comunicación Básica

12m 57s

4 ) Block Controller

0m 0s

6 ) Control de Flujo

33m 58s

7 ) Término del Entrenamiento Control 101

1m 24s

Descripción de la lección

Comentarios 4m 30s

Usa la herramienta de Comentarios para dejar notas organizacionales e instruccionales dentro de tu script de Lua o en el Block Controller.

Transcripción de video

Comentarios 4m 30s
0:08
Iniciemos nuestras lecciones de scripting con los comentarios. Cuando inicias a escribir código, te
0:13
darás cuenta que es muy útil dejar notas dentro del código. Estos son llamados comentarios y puedes
0:19
dejar comentarios dentro del código sobre lo que quieras. Esto puede ser con el propósito de
0:24
organizarte o de etiquetar diferentes secciones, o puedes usarlos para incluir instrucciones a otros
0:29
usuarios que quieran revisar tu código luego. Estos comentarios – ¡HEY! Diferentes
0:35
tipos de comentarios, ¡regresa aquí! Un comentario en un código puede ser definido
0:41
como información que está ahí para los ojos humanos, pero que es ignorado por el compilador.
0:46
Básicamente, no tiene efecto alguno en el script.
0:50
Primero veamos en Lua. Para crear un comentario, solo basta con colocar dos guiones. Cualquier cosa
0:57
después de este punto serán considerados como comentarios y su color cambiará a verde para que lo
1:03
notes. Este comentario es llamado específicamente un comentario de línea, ya que solo comenta en
1:09
la línea donde escribes. Cuando cambias a la siguiente línea de código, el script se pondrá gris de
1:15
nueva cuenta.
1:16
Si quieres añadir muchas líneas de comentario, puedes colocar de nuevo dos guiones o puedes, en
1:22
lugar de ello, elegir un comentario “multi línea”. Para crear un comentario multi línea, puedes añadir
1:28
dos guiones y después dos corchetes abiertos. Esto comentará cualquier cosa a continuación y a
1:36
través de tantas líneas de código como quieras, hasta que termines ese comentario con dos
1:41
corchetes que cierran seguido de dos guiones.
1:44
Hay una pequeña anomalía al usar comentarios multi línea – ¿Qué pasa si en tu comentario,
1:50
necesitas incluir dos corchetes que cierran por alguna razón? No quieres que termine tu comentario
1:56
antes incluyendo esto en el texto.
1:59
En este caso, puedes modificar los dos corchetes que usaste para iniciar tu comentario añadiendo un
2:04
signo de igual entre ellos, lo que básicamente cambia el tipo delimitador para marcar donde inicia y
2:11
termina tu comentario. Luego, tendrías que usar este mismo símbolo para posteriormente cerrar el
2:18
comentario multi línea.
2:20
Puedes usar la misma idea con dos o tres signos de igual si necesitas capas adicionales de
2:25
delimitadores. Esto puede ser extremo para algo tan sencillo como dejar comentarios, pero saberlo
2:32
te ayudará después cuando hablemos sobre las formas de manipular cadenas. Pero en la mayoría de
2:38
los casos, poner dos guiones será lo que necesites para comentar o en su defecto el comentario multi
2:44
línea tradicional.
2:45
Cambiando al Block Controler, puedes añadir un comentario yendo a la categoría de System y
2:50
añadiendo este bloque de aquí. Claramente dice “A comment for this block” (un comentario para
2:56
este bloque) y después puedes escribir tu comentario en el área de texto.
3:01
Opcionalmente, puedes construir un comentario directamente en la mayoría de los bloques haciendo
3:06
click derecho en el bloque y seleccionando “Show Comment” (mostrar comentario). Esto incorpora
3:12
un bloque de comentario en la parte superior del bloque, permitiéndote usar esto para títulos,
3:17
instrucciones, etc.
3:19
Y si navegas en la pestaña de Lua, puedes ver que ese comentario fue creado usando los mismos dos
3:25
guiones que aprendimos anteriormente, o incluso la versión de dos corchetes para el bloque de
3:30
comentario.
3:31
Puede que estos comentarios no aparezcan en verde en esta ventana, pero no olvides que esta
3:36
página blanca de script no puede editarse. Si convirtieras los bloques en una pantalla de código
3:42
editable, entonces sí verías estos comentarios en color verde.
3:46
Si quieres añadir comentarios a tus Control Functions, ¡es tan sencillo como añadir etiquetas! Si
3:52
utilizaras la Herramienta Gráfica, podrías añadir un Bloque de texto, un encabezado o una Caja de
3:59
Grupo, los cuales son la forma elegante de etiquetar tu diseño o dejar instrucciones para alguien que
4:05
lo vea después.
4:06
Puedes renombrar cualquiera de tus Control Components solo seleccionando el componente y
4:11
tecleando un nuevo nombre, lo que puede ser una buena forma de describir su función – lo que es en
4:16
esencia, dejar un comentario.
4:19
¡Adelante!, realiza un rápido ejercicio con comentarios en la Hoja de Trabajo, y después continua con
4:24
el siguiente video.