Cómo agregar comentarios en un archivo por lotes o CMD

Un archivo por lotes o CMD es un archivo de texto que contiene una serie de comandos que pueden ser ejecutados por el sistema operativo Windows.

Los archivos por lotes, también conocidos como scripts CMD, son una herramienta esencial en el mundo del desarrollo de software. Los archivos por lotes se pueden usar para realizar diversas tareas, como ejecutar programas, copiar archivos o cambiar la configuración del sistema. Los archivos por lotes suelen tener una extensión .bat o .cmd.

Una de las cosas importantes en la creación de un archivo por lotes es agregar comentarios. Un comentario es una línea de texto que no es ejecutada por el sistema operativo, sino que solo sirve como una nota o explicación para el creador o lector del archivo por lotes.

Los comentarios se pueden utilizar para explicar lo que hace una línea de código o para documentar la función de un archivo por lotes. Además, los comentarios también pueden ayudarle a comprender el propósito y la lógica de los archivos por lotes, así como facilitarle la modificación o reparación de archivos por lotes en el futuro.

Cómo agregar un comentario

En el lenguaje por lotes (.cmd), hay tres formas comunes de comentar o deshabilitar el código mediante  las marcas «REM»,  «::» y «%==%». Cada método tiene usos y singularidad que deben entenderse para ser utilizados de manera efectiva en el desarrollo de archivos por lotes.

1] Uso de la marca «REM»

 «REM» significa  «remark» y es un comando interno que se encuentra dentro del símbolo del sistema del procesador de comandos de Windows, que permite incluir comentarios dentro de los programas por lotes.

Un comentario es una línea de texto que no es ejecutada por el sistema operativo, sino que sólo sirve como una nota o explicación para el creador o lector del programa por lotes. Los comentarios pueden ayudarle a comprender el propósito y la lógica de un programa por lotes, así como facilitarle la modificación o mejora del programa por lotes en el futuro.

Los comentarios son esenciales para mantener la legibilidad y la comprensión del código. Puede comentar varias partes de un archivo por lotes utilizando la  marca «REM», como en el siguiente ejemplo:

REM Este es un comentario  Los comentarios 
REM No serán ejecutados por el sistema operativo

También puede utilizar las marcas REM para deshabilitar temporalmente un comando sin eliminarlo del programa por lotes. Ejemplo:

rem del C:\Windows\System32\file.txt

El comando anterior debe eliminar el archivo denominado archivo.txt de la carpeta C:WindowsSystem32, pero debido a que comienza con una marca de interrupción, no se ejecutará. Esto es útil si desea probar o depurar el programa por lotes sin cambiar los resultados.

2] Uso del signo «::»

 «::» es una alternativa más corta a agregar comentarios al código. Sin embargo, esto solo funciona cuando se coloca al principio de la línea. Si bien no es un comando oficial, se usa comúnmente y es más agradable estéticamente en código.

:: Esto también es un comentario

La ventaja de usar dos puntos es que no tiene que agregar espacios después de ellos, por lo que sus comentarios pueden ser más cortos y ordenados. Sin embargo, la desventaja de usar dos puntos es que no puede usar caracteres especiales como &, |, <, > o ^ en sus comentarios porque esos caracteres tienen funciones especiales en la sintaxis del programa por lotes.

3] Usando el signo  «%==%»

%= =% es la forma más flexible de agregar comentarios. Puede usar este método para agregar comentarios a líneas de código, parámetros de comando o variables.

Por ejemplo, el código siguiente agregará el  comentario «Este es un comentario para  la línea de código» a la primera línea de código:

set  "var=3"  %= Este es un comentario en la misma línea=%

 «%==%» es una forma menos común de deshabilitar partes del código. Esto le permite deshabilitar rápidamente varias líneas de código y reactivarlas fácilmente. Sin embargo, puede no ser tan común como otras opciones y es menos familiar para muchos desarrolladores.

La diferencia entre  «REM», «::« y «%==%»

Aquí hay una tabla que resume las diferencias entre REM, ::, y %==%:

  •  «REM» es el comando oficial para comentarios en archivos por lotes.
  •  «::» es una alternativa más corta, pero sólo funciona al principio de la línea.
  •  «%===%» es una forma menos común de deshabilitar rápidamente el código.
CaracterísticaREM::%= =%
Firmar#::%= =%
CompatibilidadTodas las versiones de CMDTodas las versiones de CMDWindows 10 y superior
FlexibilidadGuardarGuardarAlto

En general, REM es la forma más común y compatible de agregar comentarios a un archivo por lotes. :: es una forma más corta y eficiente, pero no es compatible con todas las versiones de CMD. %= =% es la forma más flexible, pero solo está disponible en Windows 10 y versiones posteriores.

¿Cuándo usar un método en particular?

  • Use  «REM» para comentarios claros y explicaciones que requieran una presentación oficial.
  • Use «::» para comentarios cortos que aclaren el código al principio de la línea.
  • Use  «%===%» para deshabilitar secciones más largas de código que deben deshabilitarse temporalmente.

Conclusión

En última instancia, su elección entre  «REM», «::»  y «%==%» depende de las preferencias personales y las demandas del proyecto.  «REM» es la opción oficial para comentarios, «::»  es una opción más concisa comúnmente utilizada al principio de una línea, y  «%==%» es una forma menos común de deshabilitar el código. Comprender las diferencias y utilizar el método que mejor se adapte a su estilo de escritura y necesidades de desarrollo

ARTÍCULOS RELACIONADOS

Artículos más recientes