强制Visual C++仅为我的文件生成XML注释？

有一个问题，我似乎无法找到直接的答案。我正处于与几个朋友一起构建游戏引擎的后期阶段，在这一点上，我们正在考虑简化评论，以便让他们对可能希望加入团队的开发人员更具可读性和实用性。由于我们使用Visual Studio 2010，嵌入式XML评论似乎是最理想的工具，而且它是！我们遇到的唯一问题是我们的引擎基于的图形库似乎具有相同的想法，并且也使用类似于XML的注释模式。不幸的是，他们用来编译XML注释的任何工具的语法都与Visual Studio中使用的不同，因此当Visual Studio尝试将其注释呈现给项目XML输出文件时，我们所得到的只是一大串错误因为我们只想要我们的代码的文档，所以无论如何都是完全不需要的。所以，简而言之，是否有一些编译参数或选项可以在Visual Studio/VC++中设置，这会强制它仅为我们的类和文档生成XML注释输出文件？非常感谢。强制Visual C++仅为我的文件生成XML注释？

来源

2011-05-27 DaveStance

或者您可以删除他们的评论？我很好奇VS应该知道哪些文件是你的。 – Fosco 2011-05-27 18:40:08

@Fosco - 只存在于项目文件夹或解决方案中的那些？它为包含在我的项目中的头文件生成注释，所以链接器自然会将它们包含在整个编译时环境中，但由于它们实际上并不驻留在我的项目文件夹中或在当前解决方案中打开， XML解析器应该能够区分这两者之间似乎并不牵强？ – DaveStance 2011-05-27 18:55:04

忘记Visual Studio并使用像doxygen这样的真实文档生成工具。它处理基于MS XML的文档，您可以将其配置为仅搜索某些文件或目录。

编辑 Doxygen的有它自己的文档标记格式described here但它也能处理的JavaDoc风格的注释。 XML样式注释是described here。

来源

2011-05-27 18:46:49

你是男人！谢谢你，这个工具非常棒！我很惊讶，当我对自动C++文档进行一般搜索时，没有得到更多关注。 – DaveStance 2011-05-27 19:16:59

没问题。就我个人而言，我更喜欢Doxygen自己的XML标记标记（少打字，更好的功能）。我不知道你是否有要求使用XML标记，但如果你不这样做，我会建议使用doxygen的标记，甚至是JavaDoc标记。另一方面，Visual Studio会自动为您标出XML标记，并且您可以混合使用doxygen样式标记... – 2011-05-27 19:55:26

强制Visual C++仅为我的文件生成XML注释？

回答

相关问题