Golang comments: Difference between revisions
From wikinotes
| (One intermediate revision by the same user not shown) | |||
| Line 16: | Line 16: | ||
The docs recommend that they begin with the name of the function. | The docs recommend that they begin with the name of the function. | ||
It is customary to have a doc-comment above every exported function,<br> | It is customary to have a doc-comment above every exported function, constant<br> | ||
and preceding a package statement (any package statement, often there is a <code>doc.go</code> for this comment). | and preceding a package statement (any package statement, often there is a <code>doc.go</code> for this comment). | ||
<syntaxhighlight lang="go"> | <syntaxhighlight lang="go"> | ||
// Words contains a collection of words to be printed. | |||
package words | |||
// Hello prints hello to STDOUT. | // Hello prints hello to STDOUT. | ||
// If you'd like to ... etc etc | // If you'd like to ... etc etc | ||
| Line 25: | Line 29: | ||
fmt.Println("hello") | fmt.Println("hello") | ||
} | } | ||
// Doc-Comments may also preceed a group of declarations | |||
var ( | |||
one = 1 | |||
two = 2 | |||
three = 3 | |||
) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
Latest revision as of 03:35, 25 May 2022
Comments
// single line comment /* Multiline * Comment */
Doc Comments
Doc-comments are regular comments that preceed a top-level declaration.
The docs recommend that they begin with the name of the function.It is customary to have a doc-comment above every exported function, constant
and preceding a package statement (any package statement, often there is adoc.gofor this comment).// Words contains a collection of words to be printed. package words // Hello prints hello to STDOUT. // If you'd like to ... etc etc func Hello() { fmt.Println("hello") } // Doc-Comments may also preceed a group of declarations var ( one = 1 two = 2 three = 3 )You can search documentation by by type in your cli
go doc -all regexp # print docs for all methods with regexp type in method signature (?)
