Go Documentation: Difference between revisions

From NovaOrdis Knowledge Base
Jump to navigation Jump to search
 
Line 5: Line 5:
=Overview=
=Overview=
Go has automatically generated documentation with testable examples.
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=
<font color=darkkhaki>
<font color=darkkhaki>
To deplete, merge and delete this:  [[Go Concepts - Documentation]]
To deplete, merge and delete this:  [[Go Concepts - Documentation]]
</font>
</font>

Latest revision as of 23:47, 25 October 2023

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