The documentation of an exported variable or constant should start with the variable’s name GO-D5003
Documentation
Minor
a month ago
—
a year old
comment on exported var FiltersEnumFuncMap should be of the form "FiltersEnumFuncMap ..."
1075 },
1076}
1077
1078// FiltersEnumFuncMap1079// A rather very complicated FiltersEnumFuncMap Variable made by me to send filters in an appropriate way
1080var FiltersEnumFuncMap = map[int]func(b *gotgbot.Bot, ctx *ext.Context, filterData db.ChatFilters, keyb *gotgbot.InlineKeyboardMarkup, replyMsgId int64, noFormat, noNotif bool) (*gotgbot.Message, error){
1081 db.TEXT: func(b *gotgbot.Bot, ctx *ext.Context, filterData db.ChatFilters, keyb *gotgbot.InlineKeyboardMarkup, replyMsgId int64, noFormat, noNotif bool) (*gotgbot.Message, error) {comment on exported var PinsEnumFuncMap should be of the form "PinsEnumFuncMap ..."
602 return ext.EndGroups
603}
604
605// PinsEnumFuncMap606// A rather very complicated PinsEnumFuncMap Variable made by me to send filters in an appropriate way
607var PinsEnumFuncMap = map[int]func(b *gotgbot.Bot, ctx *ext.Context, pinT pinType, keyb *gotgbot.InlineKeyboardMarkup, replyMsgId int64) (*gotgbot.Message, error){
608 db.TEXT: func(b *gotgbot.Bot, ctx *ext.Context, pinT pinType, keyb *gotgbot.InlineKeyboardMarkup, replyMsgId int64) (*gotgbot.Message, error) {
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 = ...