new TODOs

0 views
Skip to first unread message

Christian A. Reiter

unread,
May 22, 2012, 12:52:44 AM5/22/12
to freeme...@googlegroups.com
Hi all,

As QtCreator with v2.5 (just released) can manage TODOs in comments, I talked with Eric, and we will change the inline todos in the code from doxygen to a more convenient format. Until now, todos are written within a doxygen comment like:

/** \todo blablabla */

This is discouraged as doxygen is good for documentation of code like classes, methods, APIs etc - but must get compiled so we can see it online. This has nothink to do with the codng workflow in an IDE. Much better is just dropping the todos in normal comments:

// TODO: do the implementation here

or

/* TODO: blabla */

QtCreator then can see this todos and display them in a list, see a screenshot here.
It also recognizes WARNING, NOTE, FIXME by now.

So I will refactor all the todos in the code to the new style by now.
Please, if you write new todos, take the new format!
Thanks!

Christian

Reply all
Reply to author
Forward
0 new messages