Insanity@programming.devtoProgramming@programming.dev•The Grand Unified Theory of Documentation (AKA: Your project needs all 4 types or you have bad documentation)
1·
1 year agoAnother key point for code documentation is that the closer it is to the code it’s describing, the more likely it is to be read and maintained.
I agree with this point and it’s one I’ve always had problems with as a lot of developers seem to dislike code comments. I agree that comments shouldn’t become a crutch of bad code but good, well formatted documentation on a class or group of functions which explains their usage in relation to the product or feature they support are extremely useful and much more likely to be read by engineers than some documentation written on a notion page somewhere.
I’ve been playing around with Arrow V2 for a while and it’s really nice. I like the simplifications they’ve done which feel like they remove a lot of bloat without sacrificing the functionality.
I made a sample project with Arrow and http4k. They both work very nicely together. Link here if you’d like to take a look.