Go Documentation

From NovaOrdis Knowledge Base
Jump to navigation Jump to search

External

Internal

Overview

Go has automatically generated documentation with testable examples.

Top Level Rules

Always document packages.

Documentation comments are complete sentences that end in a period.

Documentation comments for a name (like a function name) always start with the name.

TO DEPLETE

To deplete, merge and delete this: Go Concepts - Documentation