diff --git a/go.md b/go.md index 6dbf8a5..136e9d6 100755 --- a/go.md +++ b/go.md @@ -12,10 +12,24 @@ It's easy to understand and teaches you all you need to know. # Making a web api > We need to memorize the `Handler` interface. -> ```go -> type Handler interface { -> ServerHTTP(ResponseWriter, *Request) -> } -> ``` +> +> type Handler interface { +> ServerHTTP(ResponseWriter, *Request) +> } +# `godoc` [^golang-godoc] + +> Godoc parses Go source code - including comments - and produces documentation as HTML or plain +> text. +> The end result is documentation tightly coupled with the code it documents. +> For example, through godoc's web interface [which is at by default] you can +> navigate from a function's documentation to its implementation with one click. + +## Installing godoc // `command not found: godoc` + +```bash +go get golang.org/x/tools/cmd/godoc +``` + +[^golang-godoc]: Andrew Gerrand, 31 March 2011 ---