问题标签 [xml-comments]

下面的评论只是 VS 中的一段 xml 评论，但我的问题是这样的字符< >破坏了 xml 结构。如何在 xml 注释中使用它们？

就像 Ghostdoc 一样，Visual Studio 2008 是否有任何插件可以自动为私有变量添加 XML 注释，因为 Ghostdoc 和其他少数几个不支持私有变量。

下面的代码是有效的 XML 吗？

如何在 Visual Studio 2010 中为 C++ 方法 ala C# 和 VB 启用/实现 XML 注释？默认情况下，此功能似乎未启用/可用。

以最初托管的 C++ 项目为目标。

假设在 Visual Studio 中我有一个新项目，其中包含来自旧项目的一些相同 API，并且我想将 xml 文档复制到新项目中。有没有一种方法可以在不手动复制粘贴的情况下做到这一点？

这实际上只是重新询问有关 Visual Studio 2008的问题。VS2010 是否提供任何功能来消除自动生成代码的 CS1591 编译器警告？

CS1591: Missing XML comment for publicly visible type or member

引用 VS2008 的问题：

这是一个烦恼多于一个问题。我的项目包含许多自动生成的文件（使用 mgmtclassgen.exe）。当我生成 XML 文档时，我的精美注释库受到来自这些 autogen 文件的 xml 文档警告的困扰。

有没有办法a）禁止为这些文件生成文档或b）只为一组文件禁止警告CS1591？我显然不想修改自动生成的文件，即使只是添加抑制编译指示。

编辑：在我的例子中，有问题的文件是由 WCF RIA 服务生成的，所以生成错误的文件是自动生成的 WebContext 类（MyProject.BusinessApplication.Web.g.cs）。

我无法手动修改此文件，因为它是动态生成的，所有更改都将被清除。我也不想全局禁用警告，因为它对我的非自动生成代码很有帮助。

希望有一个非常快速和简单的答案的问题；在以前版本的 Visual Studio 和 Visual Web Developer 中，我已经能够在导致自动生成注释的函数之前的行上键入 3 个撇号（即 '''），例如：

在 2010 年这样做似乎没有相同的效果，我尝试在 Google 上搜索但没有任何乐趣，这个快捷方式是否仍然可用？它是否已更改为其他内容？

谢谢，史蒂夫

我无法弄清楚，如何使用ajaxdoc为我的脚本生成注释。

如果您能提供有关此内容或示例的小教程，我将不胜感激。我需要使用这个项目的dll吗？

我的代表：我在 VS2010 中的代表上键入了 3 个斜杠“///”，然后出现了典型的自动注释。

为什么它使第二个名字=“？” ？？？它不应该是 STRING 吗？

可能重复：
如何在 xml 文档中引用泛型类和方法

我一直在使用 see cref 标记，它工作得很好，但现在我需要在 see cref 中包含一个字符串 [] 的通用列表，但文档没有正确呈现。

我认为它与 < 和 > 以及 [] 有关

这是否允许，有解决方法吗？