Go doc

From NovaOrdis Knowledge Base
Revision as of 23:40, 5 July 2024 by Ovidiu (talk | contribs) (→‎Overview)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

External

Internal

Overview

The doc command prints documentation for a package or a package member:

go doc time
go doc time.Since

It is a great exercise to use go doc in the early phase of a package's API design to see how the concepts will be rendered in documentation. Sometimes, the visualization has impact on design. go doc is the way the users will consume the package.

Use this to start a godoc server locally:

go doc --http=":8080"

TODO

Deplete: doc