Go Concepts - Documentation: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| Line 14: | Line 14: | ||
<pre> | <pre> | ||
go doc <package-name> | go doc <package-name> | ||
</pre> | |||
Example: | |||
<pre> | |||
go doc fmt | |||
</pre> | </pre> | ||
Revision as of 00:51, 2 April 2016
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>
Package
go doc <package>
Function
go doc <package> <function-name>
Example:
go doc fmt Println