having an issue that I can’t seem to find a direct answer to. I’m in the late stages of building a game engine with a few friends and at this point, we’re looking to streamline the comments to make them more readable and useful for any developers that may wish to join the team. Since we use Visual Studio 2010, the embedded XML commenting seemed like the perfect tool, and it is! The only issue we are having is that the graphics library our engine is based upon seemed to have the same idea, and also uses XML-like commenting schema. Unfortunately, the syntax of whatever tool they used to compile their XML comments is dissimilar to the one used in Visual Studio so when Visual Studio attempts to render their comments to the projects XML output file, all we get is a huge string of errors that really tie up the process and are completely unneeded anyway since we only want documentation for our code. So, in short, is there some compiler parameter or option I can set in Visual Studio/VC++ that will force it to only generate an XML-comments output file for our classes and documentation? Thank you so much.
Share
Forget Visual Studio and use a real documentation generation tool like doxygen. It handles the MS XML based documentation and you can configure it to only search certain files or directories.
EDIT Doxygen has it’s own documentation tag format described here but it also handles JavaDoc style comments. XML style comments are described here.