Is it possible to create visible documentation for package in go?

Question

How to create visible Go documentation?

That is easy to create documentation for any function in go like that:

package main

// documentation example
func DocumentedFunction() bool {
    return true
}

And i can see that documentation when i call that function:

alt text

Can i write package documentation, that will be visible from editor/IDE? Do i have to install additional tools to achieve similar behaviour for package documentation?

matkv · Accepted Answer · 2021-12-15T11:43:08.787

4

According to the official Go documentation and this link, it should be possible to create documentation for an entire package the same way you would do it for a function:

To document a function, type, constant, variable, or even a complete package, write a regular comment directly preceding its declaration, with no blank line in between.

For example: the strings package:

// Package strings implements simple functions to manipulate UTF-8 encoded strings.
//
// For information about UTF-8 strings in Go, see  https://blog.golang.org/strings.
package strings
..
..
rest of the file

So you basically just add a normal comment above the package keyword.

edited Dec 15 '21 at 11:43

answered Dec 15 '21 at 11:18

matkv

652
1
7
18

1

A more authoritative source is https://go.dev/blog/godoc. It also explains how to handle a large amount of package documentation. – Peter Dec 15 '21 at 11:41
@Peter thanks, I'll update the link! – matkv Dec 15 '21 at 11:41
is that an IDE problem that i do not recieve package documentation from outside the package when i import that? example (documentation in package is provided): https://raw.githubusercontent.com/Dancheg97/Dancheg97/main/package.png – dancheg Dec 15 '21 at 12:10
@DanilaFomin which IDE is this? – matkv Dec 15 '21 at 12:33
@matkv this is VSCode – dancheg Dec 15 '21 at 12:36

Is it possible to create visible documentation for package in go?

1 Answers1