This is a quick post to discuss the rules of comments in Go.

To quickly recap, Go comments come in two forms

// everything from the double slash to the end of line is a comment /* everything from the opening slash star, to the closing one is a comment */

As the first form declares that the remainder of the line is a comment, if you want to comment out more than one line, you need to do this

// this comment form is useful for // commenting out sections of your code // as you are working

The second form is also useful, and generally preferred, for large blocks of commentary

/* The generally accepted rule when writing large comment blocks in this form is to leave a newline at the start and the end of your comment */

One important thing to note is that comments do not nest, thus

// // This is fine because everything from the double // // slash to the end of line is ignored /* But, if you you were to start a new /* comment inside an old one the closing star slash would close the comment block and */ this line would generate a syntax error */

Association

A feature of the tools that consume Go source code, not the language, is the convention that a comment which directly preceeds a declaration is associated with that declaration.

// A Foo is a Fooid in the class of Endofoos. func Foo() { .... }

Conversely, a comment followed by a newline stands alone, it’s just a comment.

package foo // utility foos func Quxx() { ... }

godoc allows comments to be associated with any of the top level declarations; package , var , const , type , and func .

import “C”

The trap that catches people out when they are using cgo is they don’t realise the significance of the newline, or more correctly, the lack of newline between their block of C code and the import "C" declaration.

package main /* #include "stdio.h" */ import "C" func main() { C.printf(C.CString("Hello world

")) }

In this example the import "C" declaration is immediately preceded by the comment block containing our C code, in this case including stdio.h to obtain a reference to the printf function.

If there was a newline between the comment block and import "C" then the cgo preprocessor would not associate the comment with the import declaration and act as if #include "stdio.h" was never there.

% go run cgo.go # command-line-arguments 37: error: use of undeclared identifier 'printf'

Update don’t forget to read the follow up to this post.