2025-03-14 21:59:59 -06:00
|
|
|
# godoc
|
|
|
|
|
|
|
|
|
|
> View documentation for go packages.
|
2025-12-16 10:20:31 -07:00
|
|
|
> More information: <https://pkg.go.dev/golang.org/x/tools/cmd/godoc>.
|
2025-03-14 21:59:59 -06:00
|
|
|
|
|
|
|
|
- Display help for a specific package:
|
|
|
|
|
|
|
|
|
|
`godoc {{fmt}}`
|
|
|
|
|
|
|
|
|
|
- Display help for the function "Printf" of "fmt" package:
|
|
|
|
|
|
|
|
|
|
`godoc {{fmt}} {{Printf}}`
|
|
|
|
|
|
|
|
|
|
- Serve documentation as a web server on port 6060:
|
|
|
|
|
|
|
|
|
|
`godoc -http=:{{6060}}`
|
|
|
|
|
|
|
|
|
|
- Create an index file:
|
|
|
|
|
|
|
|
|
|
`godoc -write_index -index_files={{path/to/file}}`
|
|
|
|
|
|
|
|
|
|
- Use the given index file to search the docs:
|
|
|
|
|
|
|
|
|
|
`godoc -http=:{{6060}} -index -index_files={{path/to/file}}`
|
