Home
Do you create Task List Comments for your code?
  v1.0 Posted at 25/04/2018 7:50 AM by Tiago Araujo

Task List comments can be used to indicate a variety of work to be done at the location marked, including:

  • features to be added;
  • problems to be corrected;
  • classes to implement;
  • place markers for error-handling code;
  • reminders to check-in the file.

As with other Task List entries, you can double-click any comment entry to display the file indicated in the Code Editor and jump to the line of code marked. More details for Task List comments.

Here is an example: when I open this options form, I see "ssw.com.au" in the email text box, but it is actually only half of the text in that textbox, see the following captures: 

commentbytasklist1.jpg
Figure: You can see that ssw.com.au is highlighted.. and it is actually only half of the text in that textbox
commentbytasklist2.jpg
Figure: scrolling left displays the full contents of the textbox
tasklistwindow1.jpg
​​Figure: Bad example - the comment doesn't show in Task List window
tasklistwindow2.jpg
Figure: Good example - Marked TODO in the comment, so you can see it in Task List window and double-click to jump to​
tasklistwindow3.jpg
Figure: Good example - Marked HACK in the comment, so you can see it in Task List window and double-click to jump to

Related rules

    Do you feel this rule needs an update?

    If you want to be notified when this rule is updated, please enter your email address:

    Comments:

    Note: Social Media login for Yotpo is not working in IE or Safari, please use Chrome. We are waiting for Yotpo to fix it.