3 ms·
I know I will be in a small minority, but I miss the way changes were documented and explained at the top of the source code. Makes it super easy to get a fee
by ThinkBeat 2y ago
I know I will be in a small minority, but I miss the way changes were
documented and explained at the top of the source code.
Makes it super easy to get a feel for it and super easy to search for
comments on changes or jump to the part of the code you need to work on.
Yes the drawbacks are sometimes a huge list of comments before the source
code even begins, but you can quickly jump with a search for " */"
It makes the files larger, and you should be able to pull the same from whatever versioning system you use, but that involves context change
and a separate program (though if you an IDE it may be integrated).
Would be fun to have a git tool that mimics this.
Best of both worlds.
- okl 2y agoYou can give a path to git log, e.g., `git log --follow -- file.txt` If you'd put some text markers in the file's headers, e.g., `<history></history>`, you could create a script that gets the git log for each file that contains the markers and puts the log between those markers. Keep the markers to be able to rerun the script. Also need a script to purge the log when commiting. Could be automated with git hooks I guess.
- karmakaze 2y agoWe used to commit messages with "uv:" if the change was user visible and simply filter git messages with them for version release notes.
- deleted 2y ago[deleted]
- OnionBlender 2y agoAt my first job, there used to sometimes be conversations in the source code between 2 people. Reading it made me feel like an archeologist.