Archivo de la etiqueta: Comentarios

Comentarios en AppleScript

La mayoría de lenguajes de programación incluyen algún mecanismo para que el programador pueda incluir anotaciones o comentarios en el código. Esto es necesario sobre todo si ese código va a crecer mucho, se va a compartir con otros programadores o se va a trabajar de nuevo en él tras cierto tiempo y tenemos que recordar qué hacía el código y por qué decidimos hacerlo así.

Ya vimos en el artículo de Hola mundo en AppleScript al detalle que AppleScript permite incluir comentarios. En este artículo lo veremos más en detalle.

En AppleScript podemos crear un comentario de una sola línea o un comentario que agrupe un conjunto de líneas consecutivas.

Para escribir un comentario de una sola línea debemos emplear el prefijo doble guión (--) delante del comentario. Todo lo que haya a la derecha de -- se ignorará por el intérprete de AppleScript.

Para escribir un bloque de comentario en AppleScript debemos encerrar el bloque de comentario con los símbolos abre paréntesis y asterisco ((*) y cierra paréntesis y asterisco (*)). Todo lo que esté entre (* y *) se ignorará por el intérprete de AppleScript.

Ejemplo de comentarios

En el siguiente ejemplo veremos los dos tipos de comentarios que podemos realizar dentro de un script de AppleScript.


(*
AppleScript de ejemplo
(CopyLeft) Tyflos Accessible Software 2018.

Este AppleScript no hace nada importante y es una excusa para enseñar cómo funcionan los comentarios en este lenguaje de scripting.

*)

on run
-- Comienzo del script
say "Hola a todos"
-- Una pequeña pausa y nos despedimos
delay 2
say "Esto no hace nada más"
-- Fin del script""
end run

Comentarios en Swift

Cuanto más conocemos Swift más complicado se vuelven nuestros Playgrounds. Es necesario ir incluyendo anotaciones o aclaraciones en nuestro código. Veamos el siguiente ejemplo.


let num1 = 54
let num2 = 235
var resultado = 0

// Almacenamos la multiplicacion de num1 y num2 en rsultado
resultado = num1 * num2
// y lo mostramos por consola
print("El resultado de \(num1) * \(num2) es \(resultado)")

El ejemplo mostrará el siguiente resultado:

El resultado de 54 * 235 es 12690

En el código anterior hemos encontrado unas líneas de código que comienzan por dos barras inclinadas (//) esto indica que todo lo que haya a la derecha de esas dos barras inclinadas es un comentario para ayudar a comprender mejor el código.

Los programadores usamos los comentarios para multitud de funciones: describir que hace o va a hacer un trozo de código, incluir un Copyright o copyleft en el código, añadir marcas o secciones en el fichero de código para marcar zonas y movernos más rápido por un fichero de código grande, etc.

Con las dos barras inclinadas (//) sólo podemos comentar una línea de código pero en Swift podemos comentar un bloque de líneas de código si las encerramos entre los símbolos /* y */. Veamos este código de ejemplo.


/*
Playground de pruebas
w≤ww.programaraciegas.net

(Copyleft) Tyflos Accessible Software 2017
*/

// Escribimos un saludo
print("Hola mundo!")

Si ejecutamos el código anterior en un Playground se ignorarán todas las líneas de comentario y sólo se ejecutará la función print().

Conclusiones

Es muy recomendable utilizar comentarios en nuestro código tanto para nosotros mismos por si visitamos nuestro código tras mucho tiempo o por si lo compartimos con otros desarrolladores.

También podemos utilizar los comentarios para desactivar o activar zonas de código que estemos probando.

Por estas y otras razones es muy necesario que tengamos el hábito de comentar nuestro código y saber utilizar las diversas formas de incluir comentarios en nuestro código.