Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

annotation

package

Go to main page

Versions in this module

v1

v1.7.0

Oct 20, 2026

Changes in this version

type Entry

+ func (b *Entry) IsPackage() bool

type Option

+ func WithPackageDocs() Option

v1.6.2

Oct 19, 2026

v1.6.1

Oct 19, 2026

v1.6.0

Oct 19, 2026

v1.5.0

Oct 19, 2026

v1.4.0

Oct 19, 2026

v1.3.0

Oct 19, 2026

v1.2.0

Oct 18, 2026

Changes in this version

+ type Annotation struct

+ Map map[string]interface{}

+ Name string

+ Value string

+ func NewAnnotation(name string, value string) Annotation

+ func (m *Annotation) Decode(a interface{}) error

+ func (m *Annotation) RawValue() string

+ type Collector struct

+ func Collect(options ...Option) (*Collector, error)

+ func (c *Collector) Entries() []Entry

+ func (c *Collector) EntriesWith(annotation string) []Entry

+ func (c *Collector) EntriesWithArgType(annotationName string, argumentType string) []Entry

+ func (c *Collector) EntriesWithPrefix(prefix string) []Entry

+ func (c *Collector) EntriesWithResultType(annotation string, result string) []Entry

+ type Entry struct

+ Annotations []Annotation

+ Comments []string

+ Fields []EntryField

+ File string

+ Func EntryFunc

+ Header EntryHeader

+ Imports map[string]string

+ Module string

+ Package string

+ Path string

+ Struct string

+ func (b *Entry) IsFunc() bool

+ func (b *Entry) IsMethod() bool

+ func (b *Entry) IsStruct() bool

+ type EntryField struct

+ Name string

+ Tag string

+ Type string

+ type EntryFunc struct

+ Name string

+ Parameters []EntryFuncType

+ Results []EntryFuncType

+ type EntryFuncType struct

+ Name string

+ Type string

+ type EntryHeader struct

+ Description string

+ Title string

+ type Option func(*Collector) error

+ func WithFilters(filters ...string) Option

+ func WithPackages(pkgs ...string) Option

+ func WithPath(path string) Option