Go Concepts - Documentation: Difference between revisions

From NovaOrdis Knowledge Base
Jump to navigation Jump to search
No edit summary
Line 7: Line 7:


Go generates in-line documentation for symbols in packages.
Go generates in-line documentation for symbols in packages.
=Reading Documentation=
=Package=
<pre>
go doc <package>
</pre>
=Function=
<pre>
go doc <package> <function-name>
</pre>
Example:
<pre>
go doc fmt Println
</pre>
=Writing Documentation=

Revision as of 00:47, 2 April 2016

Internal

Overview

Go generates in-line documentation for symbols in packages.

Reading Documentation

Package

go doc <package>

Function

go doc <package> <function-name>

Example:

go doc fmt Println


Writing Documentation