Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Multi-line TODO: Comments in Eclipse

Tags:

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.

like image 688
Will Madison Avatar asked Jun 16 '11 21:06

Will Madison


People also ask

How do I create a TODO comment in eclipse?

An eclipse editor can be used to associate tasks with the file being edited by right clicking on the marker bar and selecting Add Task. In the dialog box that comes up enter the task description and select a priority from the priority drop down list and then click on the OK button.

How do you comment multiple lines in Java?

Multi-line comments start with /* and ends with */ . Any text between /* and */ will be ignored by Java.

How do you write comments on todo?

TODO comments are just code comments that start with a single string of capital letters like // TODO or // FIXME. Most of the TODO comments in your code are probably sitting unattended and forgotten in your team or organization's source code.


1 Answers

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. */ 
like image 175
therebelcoder Avatar answered Oct 02 '22 09:10

therebelcoder