有一个我似乎无法找到直接答案的问题。我正处于与几个朋友建立游戏引擎的后期阶段,此时,我们正在寻求简化评论,以使其对任何可能希望加入团队的开发人员更具可读性和实用性。由于我们使用Visual Studio 2010,嵌入式XML注释似乎是完美的工具,它就是!我们唯一的问题是我们的引擎基于的图形库似乎有相同的想法,并且还使用类似XML的注释模式。不幸的是,他们用来编译XML注释的工具的语法与Visual Studio中使用的工具的语法不同,因此当Visual Studio尝试将他们的注释呈现给项目XML输出文件时,我们得到的是一大堆错误由于我们只需要我们的代码的文档,所以无论如何都会占用整个过程并完全不需要。那么,简而言之,我可以在Visual Studio / VC ++中设置一些编译器参数或选项,它会强制它只为我们的类和文档生成XML注释输出文件吗?非常感谢。
答案 0 :(得分:2)
忘记Visual Studio并使用真实的文档生成工具,如doxygen。它处理基于MS XML的文档,您可以将其配置为仅搜索某些文件或目录。
编辑 Doxygen拥有自己的文档标记格式described here,但它也处理JavaDoc样式注释。 XML样式注释为described here。