如何在 Makefile 定义指令中注释一行？

Question

我想在 Makefile 的定义指令中注释一行或多行，以便在扩展指令时忽略该行。目标是放置注释行作为我的 Makefile 用户的提示，以显示定义指令中可能包含的内容的示例。该指令被扩展为一个目标。

换句话说，我想要那个 Makefile

define ECHO_FOO = 
#   @echo foo
endef

all: 
    @echo Before call
    $(ECHO_FOO)
    @echo After call

.PHONY: all

具有与此相同的行为：

define ECHO_FOO = 
endef

all: 
    @echo Before call
    $(ECHO_FOO)
    @echo After call

.PHONY: all

问题是第一个 Makefile 给了我以下错误：

process_begin: CreateProcess(NULL, #@echo foo, ...) 失败。 make (e=2): 系统找不到指定的文件。 Makefile：6：目标“全部”的配方失败 make: *** [all] 错误 2

GNU make:Makefile contents 页面声明：

在定义指令中，在定义变量期间不会忽略 cmets，而是在变量值中保持原样。扩展变量时，它们将被视为 make cmets 或配方文本，具体取决于评估变量的上下文。

但这并没有解释在哪种特定情况下 # 符号被视为制作评论或配方文本（这似乎是我遇到的问题）。

谁能告诉我如何在定义函数中将# 符号视为注释标记？

我已经尝试了以下所有行，想转义# 符号或更改缩进，但它们都没有给我正确的输出：

#@echo foo
    #@echo foo
##@echo foo
    ##@echo foo
\#@echo foo
    \#@echo foo 
/#@echo foo
    /#@echo foo 

我在 Windows 上运行 MinGW make 3.82，但我已经尝试过 make v3.82.90 和 4.1 的其他实现。

Answer 1

没有办法直接做你要求的事情。变量的内容在配方上下文中扩展，因此无论变量扩展为什么，它都将被视为配方的一部分，并且任何字符都将传递给 shell。

请注意，您可以在 UNIX shell 和 Windows command.com 中使用 :，因为 : 是 shell no-op 运算符。您必须在其后添加一个空格，否则它将尝试运行命令:echo，这不是一个有效的命令。但是，进一步注意，shell 仍然会扩展该行！这意味着如果您使用反引号等，那么它们仍然会被扩展。另请注意，由于它是一个语句，分号将停止它。比如：

define ECHO_FOO
: echo hi `echo there 1>&2` ; echo bye
endef

all: ; @$(ECHO_FOO)

这里，hi 不会被打印，因为 echo 命令没有运行，但是反引号仍然被扩展，所以 there 将被打印（到 stderr）并且分号结束“no-op”命令所以bye也会被打印出来。

如果您的命令足够简单，那么 : 将起作用，但如果它们那么简单，您会想知道为什么要使用 define...

另一种选择只是覆盖变量，而不是将其注释掉：

define ECHO_FOO = 
   @echo foo
endef

ECHO_FOO =

预计到达时间： 在 cmets 中，您确认该命令很简单。我不太明白你所说的最终用户可以扩展是什么意思，或者为什么会有所作为。

但我的意思是，如果你有一个简单的命令，你可以写：

ECHO_FOO = echo hi

不要使用define。 define 只需要用于复杂的命令：实际上它只需要用于包含未转义换行符的命令。

而且，如果你写：

ECHO_FOO =# echo hi

那么你正在使用 make cmets 注释掉变量的内容，而不是 shell cmets，所以它可以在任何地方工作。

Answer 2

在 Windows 上，您可以使用 : 作为注释字符。 MS-DOS 中传统的注释关键字是REM（如“remark”）。