我应该在批处理文件中使用哪种注释样式？

Question

我一直在写一些批处理文件，我偶然发现了这本用户指南，它提供了大量信息。它告诉我的一件事是，行不仅可以用REM注释，还可以用：注释。上面写着：

批处理代码中的注释可以使用双冒号进行，这比使用REM命令更好，因为标签是在重定向符号之前处理的。::

那么，为什么我看到的大多数指南和示例都使用REM命令呢？：是否适用于所有版本的Windows？




Answer 1

这个答案试图对本页上的许多伟大答案进行务实总结：

^{jeb的伟大答案值得特别提及，因为它确实深入，涵盖了许多边缘案例
值得注意的是，他指出，错误构造的变量/参数引用，如%~，可能会破坏以下任何解决方案，包括REM行}

>

::是一个（广泛使用的）hack，它有优点和缺点：

>

优点：

• 视觉上的独特性，可能还有打字的便利性

欺骗：

• 内部（…） 块，：可以破坏命令，安全使用的规则是有限制的，不容易记住-见下文

如果你想使用：，你有以下选择：

• 或者：为了安全起见，在（…）中做一个例外 块并在那里使用REM，或者不要在内放置注释（…） 全部
• 或者：在（…）中记住安全使用：的痛苦限制规则 ，总结在以下代码片段中：

@echo off

for %%i in ("dummy loop") do (

  :: This works: ONE comment line only, followed by a DIFFERENT, NONBLANK line.
  date /t

  REM If you followed a :: line directly with another one, the *2nd* one
  REM would generate a spurious "The system cannot find the drive specified."
  REM error message and potentially execute commands inside the comment.
  REM In the following - commented-out - example, file "out.txt" would be
  REM created (as an empty file), and the ECHO command would execute.
  REM   :: 1st line
  REM   :: 2nd line > out.txt & echo HERE

  REM NOTE: If :: were used in the 2 cases explained below, the FOR statement
  REM would *break altogether*, reporting:
  REM  1st case: "The syntax of the command is incorrect."
  REM  2nd case: ") was unexpected at this time."

  REM Because the next line is *blank*, :: would NOT work here.

  REM Because this is the *last line* in the block, :: would NOT work here.
)

请注意，这些样式都不是批处理语言直接支持的，而是可以模拟的。

内联评论：

^{*下面的代码片段使用ver作为任意命令的替代，以方便实验
*要使SET命令与内联注释一起正确工作，请双引号引用name=value部分；e、 例如，设置“foo=bar”[1]}

在这种情况下，我们可以区分两种亚型：

>

• ver

行内注释，可以放在一行的多个命令之间，理想情况下甚至放在给定命令的内部
行内注释是最灵活的（单行）形式，根据定义也可以用作下线注释。

>

<代码>版本

%=

多行（整行块）注释：

>

Zee的回答显示了如何使用“空标签”创建多行注释，但必须注意用^终止所有内部行。

Rob van der Woude的博客文章提到了另一个有点模糊的选项，它允许您以任意数量的注释行结束文件：打开（只会导致后面的所有内容都被忽略，只要它不包含（非^-转义）），即只要块没有关闭。

^{[1]使用SET"foo=bar"定义变量-即在名称和=周围加上双引号以及组合的值-在命令中是必要的，例如SET"foo=bar"}

Answer 2

REM可以注释完整的行，如果不是第一个标记的末尾，也可以在行尾注释多行插入符号。

REM This is a comment, the caret is ignored^
echo This line is printed

REM This_is_a_comment_the_caret_appends_the_next_line^
echo This line is part of the remark

REM后跟一些字符.:\/=的工作方式有点不同，它不注释&号，因此您可以将其用作内联注释。

echo First & REM. This is a comment & echo second

但是为了避免现有文件出现问题，比如REM，REM.bat或REM；。bat只能使用经过修改的变体。

REM^;<space>Comment

和字符也可以是；，：\/=

REM的速度大约是：（在Win7SP1上测试，有100000条注释行）的6倍
对于正常使用，这并不重要（每条评论行58µs与360µs）

A：始终执行行尾插入符号。

:: This is also a comment^
echo This line is also a comment

标签和注释标签：在括号块中有一个特殊的逻辑
它们总是跨越两行，因此：goto命令不起作用
因此，不建议将它们用于括号块，因为它们通常会导致语法错误。

当ECHO打开时，会显示REM行，但没有注释：

这两种方法都不能真正注释掉行的其余部分，因此简单的%~将导致语法错误。

REM This comment will result in an error %~ ...

但是REM能够在早期阶段停止批处理解析器，甚至在特殊字符阶段完成之前。

@echo ON
REM This caret ^ is visible

你可以用

存在带有百分号的注释样式。

实际上，这些都是变量，但它们被扩展为零
但优点是，即使没有

echo Mytest
set "var=3"     %= This is a comment in the same line=%

建议批处理宏使用百分比样式，因为它不会更改运行时行为，因为定义宏时注释将被删除。

set $test=(%\n%
%=Start of code=% ^
echo myMacro%\n%
)

简而言之：

• ：和%==%似乎具有相同的性能

欲了解更多信息，请参见：关于批量评论的问题*。bat文件和速度

Answer 3

tl；dr:REM是在批处理文件中嵌入注释的有文档记录且受支持的方法。

：本质上是一个无法跳转到的空白标签，而REM是一个实际的命令，它什么也不做。在这两种情况下（至少在Windows 7上），重定向操作符的存在都不会导致问题。

然而，：：在某些情况下会在块中出现错误行为，被解析为某种驱动器号，而不是标签。我对确切的位置有点模糊，但仅此一点就足以让我只使用REM。这是在批处理文件中嵌入注释的一种有文档记录且受支持的方式，而：只是特定实现的产物。

下面是一个例子，其中：在FOR循环中产生问题。

这个例子在名为test的文件中不起作用。bat在您的桌面上：

@echo off
for /F "delims=" %%A in ('type C:\Users\%username%\Desktop\test.bat') do (
    ::echo hello>C:\Users\%username%\Desktop\text.txt
)
pause

虽然此示例将正确用作注释：

@echo off
for /F "delims=" %%A in ('type C:\Users\%username%\Desktop\test.bat') do (
    REM echo hello>C:\Users\%username%\Desktop\text.txt
)
pause

问题似乎是在尝试将输出重定向到文件时。我最好的猜测是，它将：解释为一个名为：echo的转义标签。