 |
C++Talk.NET
C++ language newsgroups
|
| View previous topic :: View next topic |
| Author |
Message |
Guest
|
 Posted: Sat May 12, 2007 3:04 am Post subject: @TODO-type tags |
 |
|
Hi all,
I'm very much a C++ newbie, so forgive me if this question has come up
before. (I've been googling, but I haven't found a good answer.)
In Java there exists an @TODO tag that's part of the JavaDoc API. And,
using an IDE like Eclipse, you can very easily aggregate occurrences
of these guys and get a quick overview of the little things you've
marked as needing fixing. Is there anything in standard C++ like this?
If not, are there any add-on tools that will enable this kind of
behavior? I'm developing on a Mac using XCode, so if anyone knows of
plugins/add-ons for doing this, please let me know.
Thanks,
Aaron
--
[ See http://www.gotw.ca/resources/clcm.htm for info about ]
[ comp.lang.c++.moderated. First time posters: Do this! ] |
|
| Back to top |
|
 |
John Moeller
Guest
|
| Posted: Sat May 12, 2007 9:10 am Post subject: Re: @TODO-type tags |
|
|
On Fri, 11 May 2007 21:04:16 CST, amhoov (AT) gmail (DOT) com wrote:
| Quote: | I'm very much a C++ newbie, so forgive me if this question has come up
before. (I've been googling, but I haven't found a good answer.)
In Java there exists an @TODO tag that's part of the JavaDoc API. And,
using an IDE like Eclipse, you can very easily aggregate occurrences
of these guys and get a quick overview of the little things you've
marked as needing fixing. Is there anything in standard C++ like this?
If not, are there any add-on tools that will enable this kind of
behavior? I'm developing on a Mac using XCode, so if anyone knows of
plugins/add-ons for doing this, please let me know.
|
It's not part of C++, just as JavaDoc isn't part of the Java language.
It's an extension that supports generating documentation from
comments.
Unfortunately, no, there isn't a common way to do this. Many IDE's
will support this (in fact, you can use Eclipse with C++ code).
If you're looking for a way to generate documentation from comments,
Doxygen is a good tool for that. It can even generate comments from
JavaDoc-like comments, with similar tags.
John Moeller
--
[ See http://www.gotw.ca/resources/clcm.htm for info about ]
[ comp.lang.c++.moderated. First time posters: Do this! ] |
|
| Back to top |
|
|
Wanderley Caloni
Guest
|
| Posted: Sat May 12, 2007 9:10 am Post subject: Re: @TODO-type tags |
|
|
amhoov (AT) gmail (DOT) com escreveu:
| Quote: | In Java there exists an @TODO tag that's part of the JavaDoc API. And,
using an IDE like Eclipse, you can very easily aggregate occurrences
of these guys and get a quick overview of the little things you've
marked as needing fixing. Is there anything in standard C++ like this?
|
Hi, Aaaron.
AFAIK, you can use doxygen, that supports JavaDoc format. Doxygen is a
tool to transform comments into documentation using tokens defined by
some formats like JavaDoc. In short, you can use @TODO token inside C+
+ comments and make them work for you =)
The bad part is that C++ doesn't define such facilitie as Java does.
You see, Doxygen is just a tool, and probably there are other ones.
| Quote: | If not, are there any add-on tools that will enable this kind of
behavior? I'm developing on a Mac using XCode, so if anyone knows of
plugins/add-ons for doing this, please let me know.
|
I work in Windows, and Visual Studio has a little parse for comments
using a simple token. By example:
int main()
{
// TODO Put some code here
}
The sentence "Put some code here" is shown in a window called Task
List as the IDE recognizes the token. There are other ones, like HACK,
UNDONE and you can define new ones. Unfortunately I know nothing about
Mac+XCode facilities.
[]s
--
[ See http://www.gotw.ca/resources/clcm.htm for info about ]
[ comp.lang.c++.moderated. First time posters: Do this! ] |
|
| Back to top |
|
|
Clark Cox
Guest
|
| Posted: Tue May 15, 2007 11:56 pm Post subject: Re: @TODO-type tags |
|
|
On 2007-05-11 14:04:16 -0700, amhoov (AT) gmail (DOT) com said:
| Quote: | Hi all,
I'm very much a C++ newbie, so forgive me if this question has come up
before. (I've been googling, but I haven't found a good answer.)
In Java there exists an @TODO tag that's part of the JavaDoc API. And,
using an IDE like Eclipse, you can very easily aggregate occurrences
of these guys and get a quick overview of the little things you've
marked as needing fixing. Is there anything in standard C++ like this?
If not, are there any add-on tools that will enable this kind of
behavior? I'm developing on a Mac using XCode, so if anyone knows of
plugins/add-ons for doing this, please let me know.
|
C++ itself does not define any such tags. However, as others have
mentioned, tools such as Doxygen do exists for generating documentation
from similarly tagged files. A better place to ask Xcode-related
questions would be on one of Apple's mailing lists (such as
xcode-users) or on a mac-related newsgroup (such as
comp.sys.mac.programmer.tools)
[OT]Xcode will recognize "#pragma mark <foo>"[/OT]
--
Clark S. Cox III
clarkcox3 (AT) gmail (DOT) com
[ See http://www.gotw.ca/resources/clcm.htm for info about ]
[ comp.lang.c++.moderated. First time posters: Do this! ] |
|
| Back to top |
|
|
|
|
You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot vote in polls in this forum
|
|
FAQ
Search
Memberlist
Usergroups
Register
Profile
Log in to check your private messages
Log in
