...

/

Documenting Your Packages

Documenting Your Packages

This lesson provides information on documenting a custom package.

We'll cover the following...

The go doc tool also shows the comments in your package: the comments must start with // and precede the declarations (package, types, functions …) with no blank line in between. go doc will produce a series of Html-pages, one for each go file. For example:

  • In the folder doc_example we have the folders sort
...