Ancestors

Toot

Written by Christoph Berger on 2025-01-29 at 16:02

"Self-documenting code or external code documentation" is a false dichotomy.

Both are indispensable, on different levels.

And in-between, there are code comments.

• Clearly written code tells you what it does, and how.

• Comments summarize what a function/class/package/module is about, and clarify code that cannot describe itself.

• External documentation explain why the does that, and what it does on a higher level of abstraction (purpose, design, architecture,...)

There is no either-or.

=> More informations about this toot | More toots from christophberger@c.im

Descendants