3 ms·
> The information you are talking about is called documentation and it should exist outside of actual code files. The file in the OP is Go. In Go, you are enco
by jniedrauer 8y ago
> The information you are talking about is called documentation and it should exist outside of actual code files.
The file in the OP is Go. In Go, you are encouraged to write documentation and code in one place[0]. The end result is very nice, auto-generated, human readable documentation[1] which is tightly coupled to the code it documents.
[0]: https://golang.org/src/net/http/doc.go https://golang.org/src/net/http/doc.go
[1]: https://golang.org/pkg/net/http/ https://golang.org/pkg/net/http/