github.com/jzelinskie/conventions (go): Package conventions is an example Go package that is loaded with documentation specifically targetting new developers that have done the Go Tour and have read the documentation on the "go" binary, but want to know more about writing packages and software.  The documentation for an entire package written here; only one of the files in a package should have it. Comments are always on the line above the thing they are documenting. Package declarations and any exports require comments that should be in the form of "Package pkgname ..." and "ExportName ..." respectively. When Go is properly commented in this way, automatic docs can be generated via the "godoc" binary or via godoc.org. For example: http://godoc.org/github.com/jzelinskie/conventions is where you can see the docs for this package, although this package was created specifically to have its source read directly.
Keywords: conventions|example|go