Documentation is a huge part of writing any software. In java you have JavaDoc, which most of the developers adhere to. It is healthy and rich way of exposing the source documentation.
You spend more time reading source code than writing it, and hence it is critical to do the documentation properly.
— - Ask any engineer
GoDoc is conceptually related to Docstring and Javadoc but is simpler.
Godoc comments are just good comments, the sort you would want to read even if godoc didn’t exist.
— - Official godocblog
Convention#
To document a type, variable, constant, function, or even a package, write a regular comment directly preceding its declaration, with no intervening blank line.
godoc
