Like many modern languages, Golang has built-in inline documentation support tool called godoc
.
To be honest, it’s awesome. It is a really great tool, that has a real impact on the everyday coding process. At least if you use plugins with function call tips as I do.
But there is the big problem of the majority Go-projects that is tightly related to godoc
but lays outside of it.
The godoc
is really cool. You can document your methods and packages, paste a code snippet, that will have highlighting on the web page. Some IDE plugins will give you signature tips based on function documentation, e.g. description of parameters.