Comentarios en Editor ST

Introducción

Se pueden incluir comentarios en el código para ayudar a otros a entender la finalidad del programa o función. Los comentarios pueden colocarse en cualquier lugar donde se permita un carácter de espacio, excepto dentro de los literales de las cadenas de caracteres. Los comentarios no tienen ningún impacto en la ejecución del programa.

Comentarios de una línea

Los comentarios de una línea comienzan con una doble barra // y terminan al final de la línea. En los comentarios de una línea, las combinaciones de caracteres especiales (* y *) o /* y */ no tienen un significado especial como en los comentarios multilínea.

Ejemplo

bFan := TRUE; // Turn on the fan

Los comentarios de una línea son compatibles con Control FPWIN Pro7 a partir de la versión 7.6.0.0. Pero provocan un error de compilador en versiones más antiguas de Control FPWIN Pro7.

Comentarios multilínea

Los comentarios multilínea comienzan con (* y terminan con *) o con /* y terminan con */. Este tipo de comentario puede abarcar varias líneas. En los comentarios multilínea, las combinaciones de caracteres especiales // tienen un significado especial como en los comentarios de una línea.

Ejemplo 1	`(* Calculate fan //speed// *)`
Ejemplo 2	`(------------------- Calculate fan speed *)`
Ejemplo 3	`/* Calculate fan //speed// */`
Ejemplo 4	`/------------------- Calculate fan speed */`

NOTA

Los comentarios multilínea que emplean barras inclinadas ("/*") son compatibles con Control FPWIN Pro7 a partir de la versión 7.6.0.0. Pero provocan un error de compilador en versiones más antiguas de Control FPWIN Pro7.

Anidamiento de comentarios multilínea

Un comentario anidado es un comentario dentro de otro comentario. Los comentarios se pueden anidar si se habilita la siguiente opción: Extras > Opciones > Opciones de Compilación > Errores Adicionales > Comentarios multilínea anidados.

Con los comentarios anidados, se pueden incluir comentarios en grandes bloques de código de manera rápida y sencilla, incluso si el código ya contiene comentarios de una línea o multilínea.

Ejemplo 1

/* This is a multi-line comment
(* this is also a multi-line comment*) /*another multi-line comment*/
This is still part of the multi-line comment */

Ejemplo 2

(* Commented out code
/* Calculate fan speed */
bFan := TRUE; // Turn on the fan
*)

Comentarios incorrectos

Ejemplo 1	`(* wrong comment end characters / / wrong comment end characters *)`
Ejemplo 2	`/* Incorrect comment /* /* This should be incorrect. */`

Localizador Uniforme de Recursos (URL) en los comentarios

Se pueden utilizar URLs dentro de los comentarios. Pulsar <Ctrl> y hacer clic en el texto de la URL para abrirla en el navegador predeterminado o en la aplicación de correo electrónico.

Ejemplo
Enlace a URL	`// sample comment https://www.google.com`
Enlace a URL	`// sample comment https://www.google.com/search?q=panasonic`
Enlace de correo electrónico	`// sample comment mailto:email@example.com`
Enlace de correo electrónico	`// sample comment mailto:email@example.com?cc=secondemail@example.com,anotheremail@example.com, &bcc=lastemail@example.com&subject=Mail%20from%20our%20Website`
Enlace a archivo	`// sample comment file://C:\filename.txt`
Enlace a carpeta	`// sample comment file://C:\foldername`
Enlace a FTP	`// sample comment ftp://username@192.168.178.55:8000`

NOTA

Los espacios en la URL deben ser sustituidos por %20.

Mostrar la lista de autocompletado en los comentarios

Si se desea insertar un nombre de una variable o de una instrucción en un comentario, se puede mostrar la lista de autocompletado con la combinación de teclas <Ctrl>+<Barra espaciadora>.

Temas relacionados

Expresiones

Asignaciones

Revisar un programa

Particularidades del editor ST

Ejemplo de creación de un programa ST

Errores Adicionales

Accesos rápidos para la programación en ST