VS Code下C++贪吃蛇项目出现Multiple Definition错误求助

问题 #

开发的简易贪吃蛇游戏用Makefile编译正常，但切换到VS Code后出现链接阶段的多重定义错误，无法完成构建。

报错信息 #

Starting build...
/usr/bin/g++ -fdiagnostics-color=always -g -o /home/kali/path/snakeMain /home/kali/path/*.cpp -lncurses
/usr/bin/ld: /tmp/ccCKG1t0.o:/home/kali/path/Snake.h:9: multiple definition of `gameOver'; /tmp/ccJxCKEW.o:/home/kali/path/Snake.h:9: first defined here
/usr/bin/ld: /tmp/ccCKG1t0.o:/home/kali/path/Snake.h:14: multiple definition of `headX'; /tmp/ccJxCKEW.o:/home/kali/path/Snake.h:14: first defined here
/usr/bin/ld: /tmp/ccCKG1t0.o:/home/kali/path/Snake.h:14: multiple definition of `headY'; /tmp/ccJxCKEW.o:/home/kali/path/Snake.h:14: first defined here
/usr/bin/ld: /tmp/ccCKG1t0.o:/home/kali/path/Snake.h:17: multiple definition of `tailX'; /tmp/ccJxCKEW.o:/home/kali/path/Snake.h:17: first defined here
/usr/bin/ld: /tmp/ccCKG1t0.o:/home/kali/path/Snake.h:17: multiple definition of `tailY'; /tmp/ccJxCKEW.o:/home/kali/path/Snake.h:17: first defined here
/usr/bin/ld: /tmp/ccCKG1t0.o:/home/kali/path/Snake.h:18: multiple definition of `tailLength'; /tmp/ccJxCKEW.o:/home/kali/path/Snake.h:18: first defined here
/usr/bin/ld: /tmp/ccCKG1t0.o:/home/kali/path/Snake.h:21: multiple definition of `current_dir'; /tmp/ccJxCKEW.o:/home/kali/path/Snake.h:21: first defined here
/usr/bin/ld: /tmp/ccCKG1t0.o:/home/kali/path/Snake.h:23: multiple definition of `key'; /tmp/ccJxCKEW.o:/home/kali/path/Snake.h:23: first defined here
collect2: error: ld returned 1 exit status

Build finished with error(s).

 *  The terminal process terminated with exit code: -1. 
 *  Terminal will be reused by tasks, press any key to close it. 

相关代码文件 #

Snake.cpp #

#include <iostream>
#include <ncurses.h>
#include <unistd.h>
#include "Snake.h"

// Setup
void initTerminal() {
}

void initSnake() {
}

// Draw
void drawPixel(int y, int x) {

}

void drawBorder() {
  // PRINT MAP
}

void drawSnake() {
}

// Logic
bool collidesWithBorder() {

}

bool collidesWithSelf() {  
}

void moveSnake() {
}

bool handleKey(int key) {
}

snakeMain.cpp #

#include <iostream>
#include <ncurses.h>
#include <unistd.h>
#include "Snake.h"

int main() {
//-----here is only code and no #includes------/
return 0;
}

Snake.h #

// Copyright 2022
// Author: Darky

#ifndef SNAKE_H_
#define SNAKE_H_

//Golabal var
  // Used for the Loop
  bool gameOver;
  //field Dimensions
  const int f_width = 40;
  const int f_height = 40;
  // Coordinates for the Head of Snake
  int headX, headY;
  // Coordinates for the Tail, max Length (if we continue develop)
  // inital tailLenght (actual length is in drawSnake())
  int tailX[25], tailY[25];
  int tailLength = 0;
  // Direction param
  enum direction { STOP = 0, LEFT, RIGHT, UP, DOWN};
  direction current_dir;
  // input of the User
  int key;

// Functions
//  Initialize the Game
  void initTerminal();
  void initSnake();

// Draw the Game
  // Draw a Singel Pixel into Gamefield
  void drawPixel(int y, int x);
  // Draws the Gamefield
  void drawBorder();
  // Draw Snake with tail
  void drawSnake();

// Logic of the Game
  // Check if hit the border
  bool collidesWithBorder();
  // Check if collides with Snaketail
  bool collidesWithSelf();
  // set the direction of the snake
  void moveSnake();
  // pick input and transfer to direction
  bool handleKey(int key);

#endif // SNAKE_H_

VS Code配置文件 #

tasks.json #

{
    "tasks": [
        {
            "type": "cppbuild",
            "label": "C/C++: g++ build active file",
            "command": "/usr/bin/g++",
            "args": [
                "-fdiagnostics-color=always",
                "-g",
                "-o",
                "${fileDirname}/${fileBasenameNoExtension}",
                "${workspaceFolder}/*.cpp",
                "-lncurses"
            ],
            "options": {
                "cwd": "${fileDirname}"
            },
            "problemMatcher": [
                "$gcc"
            ],
            "group": {
                "kind": "build",
                "isDefault": true
            },
            "detail": "Task generated by Debugger."
        }
    ],
    "version": "2.0.0"
}

settings.json #

{
    "files.associations": {
        "iostream": "cpp"
    }
}

问题根源 #

错误的核心是在头文件中直接定义全局变量。当Snake.cpp和snakeMain.cpp都包含Snake.h时，每个cpp文件在编译阶段都会生成这些全局变量的独立副本，链接器尝试合并这些副本时就会触发"multiple definition"错误。

之前用Makefile编译正常，大概率是Makefile的编译逻辑没有同时触发两个cpp文件的重新编译（比如只编译了修改过的文件，旧的目标文件未被更新），但VS Code的编译命令是一次性编译所有cpp文件，直接暴露了代码本身的问题——和VS Code的设置无关。

解决方法 #

需要将全局变量的定义和声明分离：

1. 在头文件中用extern声明全局变量，告诉编译器这些变量在其他文件中定义。
2. 在其中一个cpp文件（比如Snake.cpp）中定义这些全局变量，确保整个程序只有一份副本。

修改后的Snake.h #

// Copyright 2022
// Author: Darky

#ifndef SNAKE_H_
#define SNAKE_H_

//Golabal var - 仅声明，不定义
  // Used for the Loop
  extern bool gameOver;
  //field Dimensions
  const int f_width = 40;
  const int f_height = 40;
  // Coordinates for the Head of Snake
  extern int headX, headY;
  // Coordinates for the Tail, max Length (if we continue develop)
  // inital tailLenght (actual length is in drawSnake())
  extern int tailX[25], tailY[25];
  extern int tailLength;
  // Direction param
  enum direction { STOP = 0, LEFT, RIGHT, UP, DOWN};
  extern direction current_dir;
  // input of the User
  extern int key;

// Functions
//  Initialize the Game
  void initTerminal();
  void initSnake();

// Draw the Game
  // Draw a Singel Pixel into Gamefield
  void drawPixel(int y, int x);
  // Draws the Gamefield
  void drawBorder();
  // Draw Snake with tail
  void drawSnake();

// Logic of the Game
  // Check if hit the border
  bool collidesWithBorder();
  // Check if collides with Snaketail
  bool collidesWithSelf();
  // set the direction of the snake
  void moveSnake();
  // pick input and transfer to direction
  bool handleKey(int key);

#endif // SNAKE_H_

修改后的Snake.cpp #

在文件开头添加全局变量的定义：

#include <iostream>
#include <ncurses.h>
#include <unistd.h>
#include "Snake.h"

// 全局变量定义
bool gameOver;
int headX, headY;
int tailX[25], tailY[25];
int tailLength = 0;
direction current_dir;
int key;

// Setup
void initTerminal() {
}

// ... 其余代码保持不变

修改完成后，重新运行VS Code的构建命令即可正常编译。

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