Go Concepts - Documentation

From NovaOrdis Knowledge Base
Revision as of 00:52, 2 April 2016 by Ovidiu (talk | contribs)
Jump to navigation Jump to search

Internal

Overview

Go generates in-line documentation for symbols in packages, via the go doc command.

Reading Documentation

To read the package summary:

go doc <package-name>

Example:

go doc fmt

To get the documentation for a package identifier (function name, type, etc):

go doc <package-name> <identifier>

Example:

go doc fmt Println

Writing Documentation