CODEWITHSUNDEEP
makefile
Ankur Agarwal
Ankur Agarwal

Reputation: 24748

How to add multi line comments in makefiles

Is there a way to comment out multiple lines in makefiles like as in C syntax /* */ ?

Upvotes: 153

Views: 114250

Answers (6)

Eric Melski
Eric Melski

Reputation: 16790

No, there is nothing like C-style /* */ comments in makefiles. As somebody else suggested, you can make a multi-line comment by using line continuations. For example:

# This is the first line of a comment \
and this is still part of the comment \
as is this, since I keep ending each line \
with a backslash character

However, I imagine that you are probably looking to temporarily comment out a chunk of your makefile for debugging reasons, and adding a backslash on every line is not really practical. If you are using GNU make, I suggest you use the ifeq directive with a deliberately false expression. For example:

ifeq ("x","y")
# here's all your 'commented' makefile content...
endif

Upvotes: 198

goodguy5
goodguy5

Reputation: 419

Not exactly what you're looking for, but similar in spirit. I don't expect it to be the accepted answer, but maybe it can help someone.

Assuming you're editing your makefiles in VIM:
Either decide which lines you want to comment or select them with 'v'.

Then you can use the regex s/^/#/ to comment out the lines
and s/^#// to revert them.

--Notes--

  • To open the vim command line, press : (colon)
  • To prep the command for the next 'n' lines, use .,+n
  • A sample line using "v" looks like: '<,'>s/^/#/

Upvotes: 5

giuliolunati
giuliolunati

Reputation: 766

define BOGUS
lines
.....
endef

Upvotes: 8

Mark Veltzer
Mark Veltzer

Reputation: 1534

A note about the idea of using ifeq to do multi-line comments in make(1). They don't work very well since if you write the following:

ifeq (0,1)
    do not risk ifeq comments
    else trouble will find you
    ifeq is even worse
endif

The text between the ifeq and endif will still be parsed by make which means that you cannot write whatever you want in that section. And if you want to write a long comment and write whatever you want in the comment (including $ signs, colons and more which all have a meaning for make) then you must comment every single line. So why the ifeq...:)

Upvotes: 13

Dror
Dror

Reputation: 13051

In emacs, you can mark the region you want to comment out and hit M-; (which runs comment-dwim).

Upvotes: 4

BowlesCR
BowlesCR

Reputation: 291

I believe the answer is no. The only comment styling I can find is # for each line, or use \ to wrap the first line.

Upvotes: 18

Related Questions