Doc.go: Difference between revisions

From NovaOrdis Knowledge Base
Jump to navigation Jump to search
(Created page with "=Internal= * Go_Packages#Idiomatic_Package_ConventionsGo Packages =Overview=")
 
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
=Internal=
=Internal=
* [[Go_Packages#Idiomatic_Package_ConventionsGo Packages]]
* [[Go_Packages#Idiomatic_Package_Conventions|Go Packages]]
 
=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 ...