DEV Community

Discussion on: Bullsh*t Of Self-Documenting Code

Collapse
 
adaptive-shield-matrix profile image
Adaptive Shield Matrix

I think you have to support pretty bad legacy software.
Because if it is done right -> it should be pretty self explanatory (including helpful names for functions and variables), following DRY / SOLID principles.

You have code reviews, to check if a given piece of code is understandable by other team members (without being the ones directly involved in writing it). If it is not, or you do not have a review-process in place then I suggest changing that.
You have to decide as a team how the code you wrote looks like, that guidelines to follow and how much documentation is need / acceptable.