Como adicionar comentários em um arquivo em lote ou CMD

Um arquivo em lotes ou CMD é um arquivo de texto que contém uma série de comandos que podem ser executados pelo sistema operacional Windows.

Os arquivos em lote, também conhecidos como scripts CMD, são uma ferramenta essencial no mundo do desenvolvimento de software. Os arquivos em lote podem ser usados para executar várias tarefas, como executar programas, copiar arquivos ou alterar as configurações do sistema. Arquivos em lote geralmente têm uma extensão.bat ou.cmd.

Uma das coisas importantes na criação de um arquivo em lotes é adicionar comentários. Um comentário é uma linha de texto que não é executada pelo sistema operacional, mas serve apenas como uma nota ou explicação para o criador ou leitor do arquivo em lote.

cmd two command one line

Os comentários podem ser usados para explicar o que uma linha de código faz ou para documentar a função de um arquivo em lotes. Além disso, os comentários também podem ajudá-lo a entender a finalidade e a lógica dos arquivos em lote, bem como facilitar a modificação ou o reparo de arquivos em lote no futuro.

Como adicionar um comentário

Na linguagem em lote (.cmd), há três maneiras comuns de comentar ou desabilitar o código usando as marcas “REM”, “::” e “%==%.” Cada método tem usos e exclusividade que precisam ser entendidos para serem usados efetivamente no desenvolvimento de arquivos em lote.

1] Usando a marca “REM”

 “REM” significa “observação” e é um comando interno encontrado dentro do prompt de comando do processador de comando do Windows, que torna possível incluir comentários dentro de programas em lote.

Um comentário é uma linha de texto que não é executada pelo sistema operacional, mas serve apenas como uma nota ou explicação para o criador ou leitor do programa em lote. Os comentários podem ajudá-lo a entender a finalidade e a lógica de um programa em lote, bem como facilitar a modificação ou melhoria do programa em lote no futuro.

Os comentários são essenciais para manter a legibilidade e a compreensão do seu código. Você pode comentar várias partes de um arquivo em lote usando a marca “REM”,como o exemplo abaixo:

REM Este é um comentário Comentários 
REM não serão executados pelo sistema operacional

Você também pode usar marcas REM para desabilitar temporariamente um comando sem removê-lo do programa em lote. Exemplo:

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

O comando acima deve excluir o arquivo chamado file.txt da pasta C:WindowsSystem32, mas como ele começa com uma marca de interrupção, ele não será executado. Isso é útil se você quiser testar ou depurar seu programa em lote sem alterar os resultados.

2] Usando o sinal “::”

 “::” é uma alternativa mais curta para adicionar comentários ao código. No entanto, isso só funciona quando colocado no início da linha. Embora não seja um comando oficial, é comumente usado e esteticamente mais agradável no código.

:: Este também é um comentário

A vantagem de usar dois pontos é que você não precisa adicionar espaços depois deles, para que seus comentários possam ser mais curtos e organizados. No entanto, a desvantagem de usar dois pontos é que você não pode usar caracteres especiais como &, |, <, > ou ^ em seus comentários porque esses caracteres têm funções especiais na sintaxe do programa em lote.

3] Usando o sinal “%==%”

%= =% é a maneira mais flexível de adicionar comentários. Você pode usar esse método para adicionar comentários a linhas de código, parâmetros de comando ou variáveis.

Por exemplo, o código a seguir adicionará o comentário “Este é um comentário para a linha de código” à primeira linha de código:

set “var=3” %= Este é um comentário na mesma linha=%

 “%==%” é uma maneira menos comum de desativar partes do código. Isso permite que você desative rapidamente várias linhas de código e as reative facilmente. No entanto, pode não ser tão comum quanto outras opções e é menos familiar para muitos desenvolvedores.

A diferença entre “REM”, “::”, e “%==%”

Aqui está uma tabela resumindo as diferenças entre REM, ::, e %==%:

  •  “REM” é o comando oficial para comentários em arquivos em lote.
  •  “::” é uma alternativa mais curta, mas só funciona no início da linha.
  •  “%===%” é uma maneira menos comum de desabilitar rapidamente o código.
CaracterísticaREM::%= =%
Sinal#::%= =%
CompatibilidadeTodas as versões do CMDTodas as versões do CMDWindows 10 e superior
FlexibilidadeGuardarGuardarAlto

Em geral, o REM é a maneira mais comum e compatível de adicionar comentários a um arquivo em lote. :: é uma maneira mais curta e eficiente, mas não é compatível com todas as versões do CMD. %= =% é a maneira mais flexível, mas só está disponível no Windows 10 e superior.

Quando usar um determinado método?

  • Use “REM” para comentários claros e explicações que exigem uma introdução oficial.
  • Use “::” para comentários curtos que esclarecem o código no início da linha.
  • Use “%===%” para desativar seções mais longas do código que precisam ser desabilitadas temporariamente.

Conclusão

Em última análise, sua escolha entre “REM”, “::” e “%==%” depende de preferências pessoais e demandas do projeto. “REM” é a escolha oficial para comentários, “::” é uma opção mais concisa comumente usada no início de uma linha, e “%==%” é uma maneira menos comum de desativar o código. Entenda as diferenças e use o método que melhor se adapta ao seu estilo de escrita e necessidades de desenvolvimento

ARTIGOS RELACIONADOS

Últimos artigos