Hacker News new | past | comments | ask | show | jobs | submit login

Java actually does quite well with this, but I rarely see it used in the wild: package documentation. http://www.oracle.com/technetwork/java/javase/documentation/...



In Go, you can put a comment above the package clause in any of a package's source files (including an otherwise empty one) and the tools will pick it up. e.g.:

http://golang.org/src/pkg/fmt/doc.go -> http://golang.org/pkg/fmt/




Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: