The documentation of an exported variable or constant should start with the variable’s name GO-D5003
Documentation
Minor
2 years ago
—
2 years old
comment on exported const DocURL should be of the form "DocURL ..."
27 Org *APIOrganization
28}
29
30// FIXME: move this constant to github.com/gogs/go-gogs-client 31const DocURL = "https://github.com/gogs/docs-api"
32
33// NoContent renders the 204 response.
Description
Doc comments work best as complete sentences, which allow a wide variety of automated presentations. The first sentence should be a one-sentence summary that starts with the name being declared.
If every doc comment begins with the name of the item it describes, you can use the doc subcommand of the go tool and run the output through grep.
See https://golang.org/doc/effective_go.html#commentary for more information on how to write good documentation.
Bad practice
package main
// Stores the mascot for DeepSource
var DuckNorris = ...
Recommended
package main
// DuckNorris stores the mascot for DeepSource
var DuckNorris = ...