• Advertisement
Sign in to follow this  

Commenting C++ Code

This topic is 3913 days old which is more than the 365 day threshold we allow for new replies. Please post a new topic.

If you intended to correct an error in the post then please contact us.

Recommended Posts

I know with PHP code, thier is PHPDoc where if i use comments like the ones below, it will automatically generate documentation for the code:
<?php
/**
* @desc This file displays a list of products
* 
* @copyright Kaizen Digital 2006-2007, All Rights Reserved
* 
* @author Oringal Ryan Zec 05-02-2007
* @author Last Editted Ryan Zec 05-04-2007
* 
* @todo Add confirmation page after user completes registration process
*/
?>

Is there something similair for C++ code, basically something that will parse the source files and create documentation based on comments?

Share this post


Link to post
Share on other sites
Advertisement
There is no "standard" way of doing this. For instance, VC++ EE simply uses the comment it finds before the function to display when looking up a function call.

You may consider looking at the program doxygen. It seems to be relatively simple and powerful.. even if you don't provide a lot of comments within your code.

Hope that works for you
~Zix

Share this post


Link to post
Share on other sites
That was exactly what i was looking for, i used it awhile back and forgot about it, thanks.

Share this post


Link to post
Share on other sites
Sign in to follow this  

  • Advertisement