Multi-line TODO: Comments in Eclipse

eclipse comments todo
Will Madison picture Will Madison · Jun 16, 2011 · Viewed 10.3k times · Source

Fairly straight forward question here. Has anyone figured out how to do a TODO: comment in Eclipse that spans multiple lines? I cannot for the life of me get it to work.

Answer

therebelcoder picture therebelcoder · Jul 13, 2015

I assign a short title/explanation to the TODO. This title will be picked up by your IDE and put in the task list for reference. Then underneath I describe my TODO at length.

The first line will be nicely highlighted in your code, so you can easily recognize your to-do's inline too. 

/**
*   TODO: Short explanatory title
*   Here I start a more lengthy description.
*   This can consist of as many lines as you want.
*/

Related questions

IDE comment keywords

So I only recently discovered the TODO comment. For those of you that don't know, most modern IDE's will recognize this word in a comment and flag the comment line a different colour so It stands out. EG. //Need to …

Read More
How to comment a block in Eclipse?

Does Eclipse have a hot key to comment a block? and to uncomment a block?

Read More
Making Eclipse's Java code formatter ignore block comments

Is there a way to make Eclipse's built-in Java code formatter ignore comments? Whenever I run it, it turns this: /* * PSEUDOCODE * Read in user's string/paragraph * * Three cases are possible * Case 1: foobar * do case 1 things * Case 2: fred hacker * do case 2 …

Read More