如何创建可跨多目录查找源文件并将目标文件统一存入指定目录的Makefile

Hey there! Let's build a flexible, scalable Makefile that meets your requirements, and I'll break down every part so you understand the "why" behind each line—perfect for learning as a beginner.

Here's the complete Makefile first, then we'll walk through how it works:

# 自定义源文件搜索目录：你可以在这里添加任意数量的源目录，比如以后加src3直接补在后面
SRC_DIRS := src src2

# 自动找出所有源目录下的.cpp文件
SRCS := $(foreach dir,$(SRC_DIRS),$(wildcard $(dir)/*.cpp))

# 将所有源文件转换为obj目录下的目标文件，统一存放
OBJS := $(addprefix obj/,$(notdir $(SRCS:.cpp=.o)))

# 最终生成的可执行文件名称（你可以改成自己想要的名字）
TARGET := my_program

# 编译器设置：用g++，添加基础的警告和调试信息
CXX := g++
CXXFLAGS := -Wall -Wextra -g

# 关键：告诉Make去哪里找对应的.cpp源文件（解决obj目录下.o文件的依赖路径问题）
vpath %.cpp $(SRC_DIRS)

# 声明伪目标，避免和同名文件冲突
.PHONY: all clean

# 默认执行的目标：生成可执行文件
all: $(TARGET)

# 链接所有目标文件，生成最终可执行程序
$(TARGET): $(OBJS)
	$(CXX) $(CXXFLAGS) $^ -o $@

# 编译单个.cpp文件到obj目录，自动创建obj文件夹（如果不存在）
obj/%.o: %.cpp
	@mkdir -p obj  # @符号让这条命令不在终端打印出来
	$(CXX) $(CXXFLAGS) -c $< -o $@

# 清理生成的文件：删除obj目录和可执行程序
clean:
	rm -rf obj $(TARGET)

Let's break down the logic step by step #

1. Core Variables (The Configurable Parts)

• SRC_DIRS: This is your custom list of source directories. Want to add a new src3 later? Just update this line to SRC_DIRS := src src2 src3—no other changes needed. That's the beauty of making this configurable.
• SRCS: We use two Make functions here:
  • foreach dir,$(SRC_DIRS),...: Loops through every directory in SRC_DIRS.
  • wildcard $(dir)/*.cpp: Finds all .cpp files in the current directory being looped through. The result is a full list of all your source files (e.g., src/File1.cpp src/File2.cpp src2/File4.cpp).
• OBJS: Converts our source files into object files stored in the obj directory:
  • $(SRCS:.cpp=.o): Replaces every .cpp suffix with .o (gives us src/File1.o src/File2.o ...).
  • $(notdir ...): Strips off the directory paths, leaving just the filenames (File1.o File2.o ...).
  • $(addprefix obj/,...): Adds the obj/ prefix to each filename, so we get obj/File1.o obj/File2.o ...—all neatly stored in one place.
• vpath %.cpp $(SRC_DIRS): This is critical! It tells Make: "When you need a .cpp file, look in the directories listed in SRC_DIRS." Since our object file obj/File1.o depends on File1.cpp (not src/File1.cpp), vpath lets Make automatically find the source file in the correct directory without us hardcoding paths.

2. Build Rules (The Action Part)

• all: $(TARGET): all is a "phony target" (marked with .PHONY), which means it's not a real file—it's just a shortcut to run the main build. When you type make without arguments, this is what runs, and it triggers the creation of your executable.
• $(TARGET): $(OBJS): This is the linking rule. It takes all your object files (obj/*.o) and links them into the final executable. The automatic variables here save us from typing every file:
  • $^: Represents all the dependencies (all the .o files).
  • $@: Represents the target (your executable, my_program).
• obj/%.o: %.cpp: This is the compilation rule, using a pattern match (%) to work for all .cpp files:
  • @mkdir -p obj: Creates the obj directory if it doesn't exist. The @ hides the command from being printed in the terminal.
  • -c: Tells the compiler to compile the source file into an object file (not link it yet).
  • $<: Another automatic variable, representing the first dependency (the .cpp file we're compiling).
• clean: A handy rule to delete all generated files (the obj directory and executable) so you can start fresh with a clean build.

How to Use It #

• Run make in your project root: It will compile all .cpp files from src and src2, store the .o files in obj, and build the my_program executable.
• Add new source directories: Just update the SRC_DIRS line—Make will automatically pick up new .cpp files.
• Clean up: Run make clean to delete all generated files.

内容的提问来源于stack exchange，提问作者user15745460