Go Comments

Go Tutorial

Go Comments – Complete Guide with Examples

In Go (Golang), comments are used to explain code, improve readability, and help other developers (and your future self) understand what the code does.

Comments are ignored by the Go compiler, so they don’t affect program execution.

What Are Comments in Go?

Comments are non-executable text written inside the code to describe:

  • Logic

  • Purpose of functions

  • Variables and constants

  • Important notes or warnings

Good comments make code clean, readable, and professional.

 Types of Comment in Go

Go supports two types of comments:

  1. Single-line comment

  2. Multi-line (block) comment

 Single-Line Comment (//)

Single-line comment start with //.

Example

  •  Used for short explanations
  •  Most common in Go

 Multi-Line (Block) Comment (/* */)

Multi-line comments are written between /* and */.

Example

  •  Useful for long descriptions
  •  Avoid overuse

 Inline Comment

Inline comments appear on the same line as code.

  •  Good for quick clarification
  •  Keep them short

 Comment for Functions (Very Important)

Go has a documentation tool (godoc) that reads comments.

Proper Function Comment

 Rule:
Function comment should start with the function name.

Package-Level Comment

Package comment describe what a package does.

  •  Required for public packages
  •  Used by godoc

 Commenting Constants and Variables


 

  •  Makes intent clear

Commented Code (Avoid This)

 Bad Practice

  •  Remove unused code instead
  •  Use version control (Git)

 Go Doc Comment (godoc)

Go uses comment to generate documentation.

Example

  •  Professional documentation
  • Auto-generated docs

 Best Practices for Go Comment

  •  Write comment for why, not what
  •  Keep comment simple and clear
  •  Use full sentences for public APIs
  •  Avoid obvious comment
  •  Update comment when code changes

Common Mistakes

  •  Over-commenting
  •  Commenting obvious code
  •  Outdated comment
  •  Using comment to disable code
  •  Poor grammar

Interview Questions: Go Comment

1. How many types of comment does Go support?
Two: single-line and multi-line.

2. Are comment executed by the compiler?
No.

3. What tool uses comment to generate docs?
godoc.

4. Should function comment start with function name?
Yes.

5. Are comment required in Go?
Not required, but strongly recommended.

 Summary

  • Comment improve code readability
  •  Go supports // and /* */
  • Used for documentation via godoc 
  •  Keep comment meaningful
  •  Avoid clutter

Mastering comment in Go helps you write clean, maintainable, and professional code

You may also like...