this post was submitted on 02 Oct 2023
1544 points (98.4% liked)
Programmer Humor
32558 readers
549 users here now
Post funny things about programming here! (Or just rant about your favourite programming language.)
Rules:
- Posts must be relevant to programming, programmers, or computer science.
- No NSFW content.
- Jokes must be in good taste. No hate speech, bigotry, etc.
founded 5 years ago
MODERATORS
you are viewing a single comment's thread
view the rest of the comments
view the rest of the comments
That works for newer projects, but on older projects there's a dozen commits for any given line and a handful of Jira tickets that have something to do with it, but none that say "Change exactly this". A comment why you made an interesting design decision costs a lot less time than trying to unwrap the commit history.. Especially when you can't even find a clue on why this was done as the commit might simply be "Implemented feature XY"
I think comments should be a last resort when all other methods are inadequate. Proper git commit logs have helped me many times to understand why a certain thing is needed.
Git logs don’t need maintenance either. They always tell what was true when the code was written. Comments need maintenance, and are often difficult to keep updated.
You can write a detailed comment about the whys of a particular function, only for it to become outdated in weeks when the functionality has changed.
I still haven't found a proper command or tool to do a multi-commit git blame.
Like I want to know who changed the logic in this line. But the last commit was a format refactor. And the commit before that just changed a tiny detail. So now I'm digging through the entire file history just to find the spot where this one line was introduced or actually changed.
If you have any tips for that, I'm all ears.
I usually use the GUI in IntelliJ for those kind of purposes, but any other GUI might do. Then I perform a manual binary search to find the commit I want.