Menu

TODO feature

2005-07-01
2012-12-07
  • Marek Robak

    Marek Robak - 2005-07-01

    Some professional programmers' editors (like Eclipse) marks "TODO" string in comments with special point (similar to breakpoint in debugger). The same with "BUG" string or other marks.

    It would be a great feature in Dev-PHP (and I hope it's not hard to implement). Would it possible?

     
    • Pierre Fauconnier

      According to http://wldj.sys-con.com/read/48887.htm :
      Moreover, you can configure Eclipse to recognize other tags that you define. Open the Preferences (Window Menu > Preferences) and browse to the "Task Tags" page (Java > Task Tags). You can add new tags, remove the existing ones, set priorities for different tags, and specify a default for code that Eclipse writes for you.

      Regards,
      pFa

       
    • Pierre Fauconnier

      Version 2.0.13 might implement TODO as follows :
      - configurable :
      . types (default TODO;bug;done)
      . uri to a tracker system
      - patchable (at your own risk :)
      . files' extensions
      - right-click in Editor to Add a new Item at the caret
      - from dockable panel 'Messages' a new tab called ToDo contains a listView. Right-click in the listview to :
      . Goto an item (shortcut double-click)
      . Link to a tracker system (shortcut wheel-click)
      . Edit and Delete an item (from current file only)
      . Refresh the list from All files of a project, Opened files, or Current file
      . Copy the list, including the headers, to the clipboard... spreadsheet
      - Sort the list ascending/descending with a click on column headers (no sort indicator)

      Syntax is :
      #<type> [n] [-i<ident>] [-o<owner>] [-c<class>] : <to-do item action text>

      Where :
      type      is a keyword from you own list of types. It is mandatory and must be the first token found in comment.
      n         is a priority that can be set to a number from 1 (highest) to 3 (lowest). Setting n to 0 means assign no priority. It is optional but must be specified right after the <type>.
      -i ident  is the identifier from a tracker system. Assumed to be a number in sorting, it may contain spaces and is optional.
      -o owner  is the name of a group/person responsible for the item action. It may contain spaces and is optional.
      -c class  is the class of the item. It may contain spaces and is optional.

      Warn :
      . The <to-do item action text> might not contain any character(s) that terminates a comment. Mandatory in Dialog boxes.
      . The separator <:> before the <to-do item action text> *must* be preceded by a space
      . The order in which you specify ident owner and class is not important.

      Examples :

      #todo

      // todo :rewrite this comment /**/

      /* ToDo 1  -i 3229054  -oUrs Mder or pFa  -c Ui:todo  : Do a
      todo list : like professional programmers' editors*/

      Be careful with nested to-do comments such as the following :
      /*This is an embedded comment.
      /*TODO -oBoss : This won't work ! However it could be nice :) */
      */

      Unicode not tested... subversion repository updated.

      Regards.

       

Log in to post a comment.

MongoDB Logo MongoDB