Go Concepts - Documentation: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| Line 35: | Line 35: | ||
=Writing Documentation= | =Writing Documentation= | ||
==Package-Level Documentation== | |||
==Package Identifier Documentation== | |||
Revision as of 01:47, 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>
Example:
go doc fmt Println