The Linux codebase has over 3k TODO comments, many from over a decade ago

Re:The Linux codebase has over 3k TODO comments, many from o... by smcl on Monday December 30, 2019 @06:43AM (#21912666)

I don't think anyone's saying that any time you encounter something which needs fixing you should drop your current work, open up the ticketing system and type out a detailed description there. It's just that the TODO comments shouldn't be part of your final commit (or equivalent).

Think of it like those little `print(f"foo is {foo}")` statements you add or the code you comment out while debugging - you use them to quickly develop piece of functionality, then you back them out before `git commit`. This is the point where you'd collect them together and create the tickets - your local work is "done" and you're doing a final review.

[ Parent | on HN ]

Re:The Linux codebase has over 3k TODO comments, many from o... by sullyj3 on Saturday January 04, 2020 @05:36AM (#21954124)

That's a fair point!

Edit: No I thought about it, and I changed my mind again. The TODO comments are primarily for the benefit of the subsequent readers, so they're not having to do so much exegesis and assorted WTFing. If you only have that info in the issue tracker, it's only available to the person dealing with that issue, not the people who have to deal with that code in the course of other maintenance.

[ Parent | on HN ]