Doc.go: Difference between revisions

From NovaOrdis Knowledge Base
Jump to navigation Jump to search
 
Line 3: Line 3:


=Overview=
=Overview=
<code>doc.go</code> contains the documentation for the packages that need a large amount of it. The file only contains the package clause and the package comment.
=Example=
<syntaxhighlight lang='go'>
package example
// This is the package documentation ...
</syntaxhighlight>

Latest revision as of 17:02, 29 January 2024

Internal

Overview

doc.go contains the documentation for the packages that need a large amount of it. The file only contains the package clause and the package comment.

Example

package example

// This is the package documentation ...