logoalt Hacker News

kalaksitoday at 7:25 AM1 replyview on HN

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.


Replies

habinerotoday at 7:46 AM

There's no way around just learning the codebase. I have never seen code documentation that was complete or correct, let alone both.

show 2 replies