Documentation of an exported function should start with the function’s name GO-D5001
Documentation
Minor
10 months ago
—
10 months old
comment on exported method PostGithub should be of the form "PostGithub ..."
27 app.conn.Publish(jsonData, repo)
28}
29
30// githubHandler handles the github webhooks post requests.31func (app *Application) PostGithub(c *gin.Context) {
32 repo := "Github"
33 jsonData, err := c.GetRawData()comment on exported method PostGitlab should be of the form "PostGitlab ..."
37 app.conn.Publish(jsonData, repo)
38}
39
40// gitlabHandler handles the github webhooks post requests.41func (app *Application) PostGitlab(c *gin.Context) {
42 repo := "Gitlab"
43 jsonData, err := c.GetRawData()comment on exported method PostBitbucket should be of the form "PostBitbucket ..."
47 app.conn.Publish(jsonData, repo)
48}
49
50// bitBucketHandler handles the github webhooks post requests.51func (app *Application) PostBitbucket(c *gin.Context) {
52 repo := "BitBucket"
53 jsonData, err := c.GetRawData()
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
// This function tries to summon a cybernetically enhanced duck
func SummonDucks() {
}
Recommended
package main
// SummonDucks tries to summon a cybernetically enhanced duck
func SummonDucks() {
}