STORY
Code and Commit Self-Documentation Philosophy
Code and Commit Self-Documentation Philosophy
- Explaining the difference between documenting the "what" and the "why" in programming.
Code and Comments
- On March 10, 2026, I shared my philosophy on self-documenting code.
- I argued that while code should reveal what it is doing, it rarely explains why it is doing it, which is the proper role of well-written comments.
- I applied the same logic to version control, stating that while a diff shows what changed, the commit message must capture why the change was made.
These facts are as Randal recalls them, but much time has passed for most of this. If you find a factual error, please email realmerlyn@gmail.com.