Go Comments

How it works

A double slash starts a line comment. Slash-star and star-slash enclose a block comment. Explain why a rule exists rather than translating every statement. Documentation comments for exported declarations conventionally begin with the declaration name.

Run this Go example

Install Go separately from the official Go downloads and check go version in a new terminal. The reviewed baseline is Go 1.27.3 on Windows amd64; the authored syntax and standard-library APIs require Go 1.22 or newer. Save the complete source below as comments.go in a learning folder, then run go run comments.go from that folder. These examples use only the standard library.

Bhylu has no Go browser runner. Apache, MySQL, PHP and the JavaScript or Python playground are not required to run these files. File examples own a temporary directory; HTTP client examples create an ephemeral loopback server and close it. They do not contact an external API.

Download the complete comments.go · Download all source files with hash checks

For the optional collection download, save download-examples.mjs in a new learning folder and run node download-examples.mjs. A local preview uses node download-examples.mjs http://127.0.0.1:8000/examples/go/. The downloader refuses an existing bhylu-go-examples folder and installs or executes no Go code.

Example

package main

import (
	"fmt"
)

func main() {
	// Keep two lockers free for oversized deliveries.
	const total = 12
	const reserve = 2
	/* Availability excludes the reserved spaces. */
	fmt.Println(total - reserve)
}

Expected result

10

The subtraction is easy to read; the comment records why two spaces are excluded. Comments are ignored during execution and cannot enforce a business rule.