1

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

4

1 回答 1

2

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


EDIT Doxygen 有它自己的文档标记格式,这里描述,但它也处理 JavaDoc 风格的注释。XML 样式注释在此处描述

于 2011-05-27T18:46:49.753 回答