Sign in to follow this  
AndreiVictor

Tools Suggestions for Easy Documentation

Recommended Posts

AndreiVictor    145
Hi. I already been using a coding standard for years, and I just wanted to know if there are any tools or plug-ins for visual studio that will aid me in putting properly formatted documentation code on my source codes. It can be as simple as key strokes. Here are examples of what I put in on my source codes:
// this is at the top of header files
///////////////////////////////////////////////////////////////////////////////
/// Player class
/// @author: Andrei Victor (xxx@xxxxxxx.net)
/// This class is blah blah
///////////////////////////////////////////////////////////////////////////////


// ...

///////////////////////////////////////////////////////////////////////////////
/// SwitchPlayers function
/// This function helps two players switch their situations and states in the
/// game.
/// @param  p_first - the pointer to the first player to switch with player 2
/// @param  p_second - the pointer to the second player to switch with player 1
/// @return true if the operation is successful, otherwise false.
///////////////////////////////////////////////////////////////////////////////

As you can see, I put in headers for my class definitions, functions, and methods like the one above. I wish to have some kind of keystroke to paste in those formatted remarks on my code.

Share this post


Link to post
Share on other sites
ApochPiQ    23006
It's not too difficult to write a quick plugin; I did one for work (which unfortunately I can't share) in about a week that includes intelligent comment-template placement and a few other nifty features.

Share this post


Link to post
Share on other sites
AndreiVictor    145
You know what. You're right.

Then again, upon finishing downloading the Visual Studio 2008 SDK. Microsoft complains I don't have it.

Doh! Now, my problem shifted to whether I should go out and buy Visual Studio 2008 or just stick with my beloved Visual C++ Express 2008.

P.S. I just realized how VC++ 2008 Express can't support plug-ins. Double-Doh!

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