logoalt Hacker News

wvenabletoday at 5:15 AM2 repliesview on HN

> If good code was enough on its own we would read the source instead of documentation.

That's 100% how I work -- reading the source. If the code is confusing, the code needs to be fixed.


Replies

kalaksitoday at 7:25 AM

Confusing code is one thing, but projects with more complex requirements or edge cases benefit from additional comments and documentation. Not everything is easily inferred from code or can be easily found in a large codebase. You can also describe e.g. chosen tradeoffs.

show 2 replies
dkerstentoday at 11:40 AM

Code alone can never describe intent or rationale.

show 1 reply