How do I mark and label "To-Do"s?

Question

How do I clearly mark and label "To-Do"s directly in my code (using Atom on Mac) for later?

Write a failing test? In your case 2, the idiomatic exception would be `NotImplementedException`. — jonrsharpe, May 19 '17 at 16:46
I use #TODO and then use `grep -n` from the command line to list them all out with the line numbers (-n). That is if you're on Linux. — Rolf of Saxony, May 19 '17 at 17:09
@TadhgMcDonald-Jensen this question is a poor fit over there for the same reasons as here. Please abstain of recommending sites you're not familiar with. See **[What goes on Software Engineering (previously known as Programmers)? A guide for Stack Overflow](https://softwareengineering.meta.stackexchange.com/q/7182/31260)** — gnat, May 19 '17 at 20:23
@gnat I've seen and read that post, I've read the on-topic help for that site and have looked at some top questions. I don't think this question is off-topic for either site and still think it's more on-par with software engineering. I admit I meant "stackoverflow is more about **technical** problems" where I said 'objective based', that is on me. — Tadhg McDonald-Jensen, May 19 '17 at 21:01
@gnat I don't think it's that poor of a fit for this site. It's an IDE question, which is on topic. I also seem to be missing some context due to deleted comments though. — Carcigenicate, May 20 '17 at 13:51

score 3 · Answer 1 · answered May 19 '17 at 16:47

This doesn't strictly satisfy your requirement of not using comments, but most IDEs support "Todos". Just start a comment with "todo":

# TODO: Fix this code!

In many IDEs, this will cause the comment to be marked in some bright color (light blue in IntelliJ), and put it into a TODO section so it can be viewed later. This can also affects things like Git commits. I'm warned if I try to commit code that contains a TODO.

score 3 · Accepted Answer · answered May 19 '17 at 16:49

3

I'd just mark your comments with # TODO. Most IDEs have a way of aggregating these comments to a list. Atom is no different, although you'd need to install a plugin for it.

answered May 19 '17 at 16:49

Mureinik

297,002
52
306
350

1

Plugin works well! Certain syntax themes also make `TODO` stand out more in Atom, such as "Solarized Dark" – JBallin May 19 '17 at 17:28
The syntax highlighting is free though. – Matthew Schuchard May 20 '17 at 13:32

score 2 · Answer 3 · answered May 19 '17 at 16:51

2

I use inputs with a description of the surrounding code/what needs done, they stop execution to make it obvious something needs done while allowing you to continue.

answered May 19 '17 at 16:51

Nick is tired

6,860
20
39
51

How do I mark and label "To-Do"s?

3 Answers3