Can anybody point me to an example of what good source code documentation looks like?


Mind you, even documentation is subject to one's personal taste...

that said, I'd check out the Go and Qt sources. They provide some of the best API / interface documentation I got to work with.

The German book "weniger schlecht programmieren" has a chapter on this I think I saw at least one book only dedicated to this but I don't remember the name.

Sign in to participate in the conversation
Toot Planet

Welcome to the Planet! We're a small but unrestrictive community and customized Mastodon server.

We welcome anyone who wants to come join and whatever language you speak! Especially if you're a creative type, queer, a nerdy enthusiast of Something, you'll feel right at home, but we're proud to be a friendly and welcoming community.

We also have certain features that don't exist on most mastodon servers, such as being able to post to only other members of the Planet.