Go Documentation: Difference between revisions
Jump to navigation
Jump to search
| (3 intermediate revisions by the same user not shown) | |||
| Line 3: | Line 3: | ||
=Internal= | =Internal= | ||
* [[Go Engineering#Subjects|Go Engineering]] | * [[Go Engineering#Subjects|Go Engineering]] | ||
= | =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. | ||
Go | |||
Documentation comments for a name (like a function name) always start with the name. | |||
=TO DEPLETE= | |||
<font color=darkkhaki> | |||
To deplete, merge and delete this: [[Go Concepts - Documentation]] | |||
</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