Home
Comments - Do you create Task List Comments for your code?
  v5.0 Posted at 2/08/2018 5:17 PM by Partho P. Das

​​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.

asd

task-list-eg-1.png

​​Figure: Bad example - the comment doesn't show in Task List window
task-list-eg-2.png
Figure: Good example - Marked TODO in the comment, so you can see it in Task List window and double-click to jump to​
task-list-eg-3.png
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.