如何使XML注释显示在Visual Studio类向导说明中



我已经将XML注释放在一个C++源文件中,IntelliSense似乎可以拾取并使用该文件。它创建了一个项目xml文件,IntelliSense在编辑原始源文件时工作(在选择成员函数或输入参数时显示注释)。

但是,当我转到Visual Studio 2012学习版中的类向导时,输入的描述不会出现在任何位置(例如,在方法上,对话框底部,其中的描述仍然为空)。就这一点而言,IntelliSense只在原始文件中工作,所以当在单独的文件中使用调用时,我的XML注释都不会被拾取。为什么它只在原始源文件中工作?我忽略了做什么?

不幸的是,我不认为您忽略了做任何事情。

类向导是在Visual Studio支持XML文档注释之前构建的,所以很可能没有人记得/愿意回到"类向导"对话框中添加对它们的支持。

根据我的经验,虽然听起来你的运气稍微好一点,但在使用C++时,XML文档注释并不是特别受支持。例如,VS 2012是第一个在IntelliSense中支持它们的版本(即使这样也不完整)。在VS2010和早期版本中,您什么也得不到,尽管它们会很乐意输出一个项目XML文件。可怜的缺乏支持,再加上尖括号税,驱使我在编写C++代码时改用Doxygen。

相关内容

最新更新