Golang comments

From wikinotes


// single line comment

/* Multiline
 * Comment

Doc Comments

Doc-comments are regular comments that preceed a top-level declaration.
The docs recommend that they begin with the name of the function.

It is customary to have a doc-comment above every exported function, constant
and preceding a package statement (any package statement, often there is a doc.go for this comment).

// Words contains a collection of words to be printed.
package words

// Hello prints hello to STDOUT.
// If you'd like to ... etc etc
func Hello() {

// Doc-Comments may also preceed a group of declarations
var (
    one = 1
    two = 2
    three = 3

You can search documentation by by type in your cli

go doc -all regexp  # print docs for all methods with regexp type in method signature (?)