2 ms·
Self-documenting code is a total myth. Instead of the author documenting what a piece of code does, why it does it that way and how to use it everyone who works
by faizshah 6y ago
Self-documenting code is a total myth. Instead of the author documenting what a piece of code does, why it does it that way and how to use it everyone who works on that code has to spend hours looking through the commit history, merge requests, design docs, wiki history, asking around etc piecing together the history and conversations around the code.
Sometimes these artifacts don’t exist so then you have to go do the same research the author did to write the code just to figure out why the code exists...
Note that none of those activities are reading the code itself because you can do that in both scenarios.