Guides for SE student projects »

VS Code - Creating a New Java Project

This guide will walk you through creating a new Java project in VS Code from scratch.

Prerequisites

Creating a new project

There are two methods you can use to create a new Java project:

• Method 1: Use VS Code's project wizard
• Method 2: Create project manually

Method 1: Use VS Code's project wizard

The easiest way to create a new Java project is using VS Code's built-in project wizard.

1. Open the Command Palette: / Ctrl+Shift+P | Cmd+Shift+P
2. Type Java: Create Java Project and select it
3. Select the desired build tool:
   • No build tool - For simple projects
   • Gradle - For projects that will use Gradle build system
   • Maven - For projects that will use Maven build system
4. Choose the location and enter the project name as prompted
5. VS Code will create the basic project structure for you

Method 2: Create project manually

If you prefer more control over the project setup, you can create a project manually.

• 1

  Step 1: Create a workspace folder

  • a)
    Create a project folder on your computer (e.g., MyJavaProject)
  • b)
    Open VS Code and select File → Open Folder...
  • c)
    Navigate to and select your project folder
  • d)
    Click "Select Folder" to open it as a workspace

• 2

  Step 2: Set up the project structure

  Create the following simple folder structure:

  MyJavaProject/
  └── src/
      └── (your Java source files will go here)
  
      
  
      Copy
      
  
      
  
  
      
      
      

  • a)

    Open the Explorer panel: / Ctrl+Shift+E | *md+Shift+E`

  • b)

    Right-click in the Explorer panel

  • c)

    Select New Folder

  • d)

    Name it src

    VS Code automatically handles compilation, so you do not need separate folders for compiled .class files.

• 3

  Step 3: Create your first Java class

  • a)

    Right-click on the src folder

  • b)

    Select New File

  • c)

    Name it HelloWorld.java

  • d)

    Add the following code:

    public class HelloWorld {
        public static void main(String[] args) {
            System.out.println("Hello, World!");
        }
    }
    
        
    
        Copy
        
    
        
    
    
        
        
        

  • e)

    Save the file: / Ctrl+S | Cmd+S

    VS Code will automatically compile the Java file when you save it.

Configuring your JDK

After creating your project, you may need to verify and configure VS Code to use the correct JDK version.

1. Open the Command Palette: / Ctrl+Shift+P | Cmd+Shift+P
2. Type Java: Configure Java Runtime and select it
3. Verify your JDK appears in the dropdown list and is selected
4. Select the appropriate JDK if you have multiple versions installed

Configuring project settings

Manual Configuration

To view and modify project settings:

1. Open the Command Palette: / Ctrl+Shift+P | Cmd+Shift+P
2. Type Java: Open Project Settings and select it
3. Configure as needed:
   • Source paths - Directories where your Java source files are located
   • Output path - Directory where compiled .class files will be stored
   • Libraries - External JAR files or libraries your project depends on
   • JDK version - The JDK version to use for compilation and runtime

Using .vscode/settings.json

You can also configure project settings by creating a .vscode/settings.json file in the root directory:

{
    "java.project.sourcePaths": [
        "src"
    ],
    "java.project.outputPath": "bin",
    "java.project.referencedLibraries": [
        "lib/**/*.jar"
    ]
}

    

    Copy
    

    


    
    
    

Configuring Git

If you are using Git to version control the project, you may want to add the following to your .gitignore file:

# Compiled class files
*.class

# VS Code workspace settings
.vscode/

    

    Copy
    

    


    
    
    

Running your project

1. Open your Java file with a main method
2. To run the code, click the "Run" button that appears above the main method or in the top right corner of the editor
3. Check the terminal output to see your program's output

---

Contributors: John Wong (@Johnwz123)