Go Variables

« Previous Next »

Go Comments

Comments are an essential part of writing clean and maintainable Go programs. They allow developers to explain logic, document functionality, and temporarily disable code during testing—all without affecting program execution.

What Are Comments in Go?

A comment is non-executable text in your code that is ignored by the Go compiler. Comments are primarily used to:

• Explain complex logic
• Improve code readability
• Document functions and modules
• Temporarily disable code during debugging

Types of Comments in Go

Go supports two types of comments:

• Single-line comments
• Multi-line (block) comments

Single-Line Comments in Go

Single-line comments begin with // and continue until the end of the line.

Example: Basic Single-Line Comment

package main import "fmt" // Entry point of the program func main() { // Print a welcome message fmt.Println("Welcome to Go programming") }

Welcome to Go programming

Example: Inline Comment

You can also place comments at the end of a line:

package main import "fmt" func main() { message := "Go is simple and powerful" fmt.Println(message) // Output the message }

Go is simple and powerful

Multi-Line Comments in Go

Multi-line comments (also called block comments) begin with /* and end with */. Everything between these symbols is ignored by the compiler.

Example: Multi-Line Comment

package main import "fmt" func main() { /* This program demonstrates how multi-line comments work in Go. The message below will be printed to the console. */ fmt.Println("Understanding Go comments") }

Understanding Go comments

Example: Commenting Out Code

Comments are often used to disable specific lines of code during testing:

package main import "fmt" func main() { fmt.Println("This line will execute") // fmt.Println("This line is temporarily disabled") }

This line will execute

Documentation Comments

In Go, comments placed immediately before functions or types are used for documentation:

// calculateArea returns the area of a rectangle func calculateArea(length, width int) int { return length * width }

// Function definition only - requires a main() function to run

These comments can be processed by tools like go doc to generate documentation.

« Previous Next »