Sign in to follow this  
RyanZec

Commenting C++ Code

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
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

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

Sign in to follow this