Closed eduncan911 closed 9 years ago
just tweaking documentation to match GoLang's RFC specs for commenting:
http://blog.golang.org/godoc-documenting-go-code
FYI, I also use Dave Cheney's godoc2md package for documenting my projects:
https://github.com/davecheney/godoc2md
You can see an example of how it outputs on another project I work on:
https://github.com/eduncan911/es ^- i did not create this README.md, the godoc2md did from my code's documentation.
It's nice as you can change your "Usage:" comments to actually give example code, and it shows up as examples.
just tweaking documentation to match GoLang's RFC specs for commenting:
http://blog.golang.org/godoc-documenting-go-code
FYI, I also use Dave Cheney's godoc2md package for documenting my projects:
https://github.com/davecheney/godoc2md
You can see an example of how it outputs on another project I work on:
https://github.com/eduncan911/es ^- i did not create this README.md, the godoc2md did from my code's documentation.
It's nice as you can change your "Usage:" comments to actually give example code, and it shows up as examples.