Golang Comments

Comments are pieces of text in programming that are non-executable code lines. It allows programmers to explain their code in their own words. Programmers help document their work by providing a description of variables, methods, and specific parts of the code. The compiler ignores comments, so they do not affect the program execution.

The comments can be written using single-line comments (//) and multi-line comments (/* */).

Golang Simple Comments Example

Let us take a simple example to illustrate the comments in Go programming.

Output:

The sum of the numbers is: 30

Explanation:

In the above example, we declare two variables, m and n and assign the values 10 and 20. After that, we add the numbers and store the outcome in the variable s. We use comments (//) to explain each step for better understanding.

Types of Comments in Golang

There are two types of comments that are as follows:

• Single-line Comment
• Multi-line Comment

1. Single-Line Comments

Single-line comments are written using two forward slashes (//). The Go compiler ignores everything from the slashes to the end of the line. It is useful for short explanations or notes.

Syntax:

It has the following syntax.

Example:

Let us take an example to demonstrate the use of single-line comments.

Output:

Welcome to Tpoint Tech

Explanation:

In the above example, we use a single-line comment. The line (//) for printing a simple message. This message is only for understanding and it ignores by the compiler. In the main function, we use the fmt.Println() method to print Hello World on the screen.

2. Multi-Line Comments

Multi-line comments are written using /* to start and */ to end. It is also called block comments. It is useful when we want to write detailed explanations.

Syntax:

It has the following syntax.

Example:

Let us take an example to demonstrate the use of multi-line comments in Go.

Output:

Welcome to Tpoint Tech

Explanation:

In the above example, we use a multi-line comment written between /* and */ to describe the purpose of the program. This comment is only for understanding the code and is ignored by the compiler. Inside the main function, we are using the fmt.Println() to print "Hello World" on the screen.

Documentation Comments in Golang

Documentation comments describe functions, variables, or packages. They are used to generate official documentation. Go provides built-in tools like godac that read these comments and produce structured documentation.Top of Form

Example of Documentation Comments

Here’s an illustrative example to demonstrate the use of documentation comments in the Go programming language.

Output:

The sum is 12

Explanation:

In this example, we use the documentation comments (//) to describe the purpose of each function. First, we create a function named add that takes two numbers as input and returns their sum. Inside the main function, we call the add() function with values 5 and 7, and print the output.