I'm pretty sure "XXX" in their case was chosen exactly because of the more general meaning. I'd sit on a bunch of their code reviews meetings, I bet they have a lot of fun when one of those TODO's pop-up.
The Code Is the To-Do List
11–20 of 80 posts
Re: The Code Is the To-Do List
#12The beauty of this idea is that it solves the usual to-do list problem of adding a task and then ignoring it forever.
Re: The Code Is the To-Do List
#13Nice article and idea. I've used TBD comments for years but it was always up to me to informally circle back later and deal with them. An automated commit/merge-stopper seems like a good way to approach it.
The observations about maintaining the context of what you're working on in your short-term memory, and how much faster you can do things that require it while you have it are very true.
Re: The Code Is the To-Do List
#14Mark Seeman wrote a book about Writing code that fits in your head.
It's a really good read.
https://blog.ploeh.dk/2021/06/14/new-book-code-that-fits-in-...
Re: The Code Is the To-Do List
#15One of my favorite small linters I made on a previous team: // todo 2022-06-09 something ^ on that date, it'd fail the linter, and print the comment. Every TODO needed a date. Got a failure and need to get past it for now? No problem: bump the date for a week or something. Now at least two people are aware that it exists (author+reviewer)... and one is in the git history for that line. Makes it rather easy to trace b…
nice trick, placing scheduling in code seems interesting
Re: The Code Is the To-Do List
#16I like todo comments, but I feel like they miss a dashboard.
Could have been a cool approach of GitHub or gitlabs issue tracker to be some sort of to-do comment tracker
Re: The Code Is the To-Do List
#17One of my favorite small linters I made on a previous team: // todo 2022-06-09 something ^ on that date, it'd fail the linter, and print the comment. Every TODO needed a date. Got a failure and need to get past it for now? No problem: bump the date for a week or something. Now at least two people are aware that it exists (author+reviewer)... and one is in the git history for that line. Makes it rather easy to trace b…
I'm going to give this a try. Thanks for throwing the idea out there!
Re: The Code Is the To-Do List
#18One of my favorite small linters I made on a previous team: // todo 2022-06-09 something ^ on that date, it'd fail the linter, and print the comment. Every TODO needed a date. Got a failure and need to get past it for now? No problem: bump the date for a week or something. Now at least two people are aware that it exists (author+reviewer)... and one is in the git history for that line. Makes it rather easy to trace b…
I had a similar idea a few years ago, but with a git hook.
Re: The Code Is the To-Do List
#19I just put //TODO: and don't see a linter for it adding anything really. I don't think I've ever checked in that way, because I read all my code right before I check in, but maybe this is a difference in workflow (I've mostly used p4; I can see a git workflow that involves lots of local commits being different.)
Re: The Code Is the To-Do List
#20I always use code comments with my name during the work to help me remember things I want to change but don't want to do them right in this moment. Then before pushing I make sure there is no comment bearing my name.