documenting your code

hello,

If I recall Java has a tool, I believe it's called Javadoc or something of that nature, that allows you to conveniently document your code. If I remember correctly, it generates HTML files based on what you supply in the javadoc comments describing what a function does, the required arguments, the return value, etc.

I am wondering if there is an equivalent tool that can be used for my C++ programs when working in Visual Studio 2010. Does anyone have any suggestions?

Did you try Google? Doxygen is probably the most popular, but there are others too.

http://www.gamedev.net/community/for...opic_id=425419
http://stackoverflow.com/questions/1...entation-for-c

Quote:

---

Originally Posted by ttrz

Does anyone have any suggestions?

---

Here's a list,

http://en.wikipedia.org/wiki/Compari...ion_generators

Definitely DOxygen for me. It can export to PDF, HTML, LaTeX... and almost everyone understands it in the code too.

Okay, thanks. I wasn't sure if a feature like this was built into VS 2010. Based on the responses, it seems that it isn't I'll take a look at DOxygen thanks.