Comments - Do you create Task List Comments for your code?

Last updated by Matt Goldman [SSW] over 1 year ago.See history

This rule has been archived
Archived Reason: Consolidated with todo-tasks - https://www.ssw.com.au/rules-legacy/todo-tasks

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.

pic1
Figure: Bad example - the comment doesn't show in Task List window

pic2
Figure: Good example - Marked TODO in the comment, so you can see it in Task List window and double-click to jump to

pic3
Figure: Good example - Marked HACK in the comment, so you can see it in Task List window and double-click to jump to


Adam Cogan
We open source.Loving SSW Rules? Star us on GitHub. Star
Stand by... we're migrating this site to TinaCMS