问题标签 [xml-comments]

可能重复：
如何在 C# 中的 <seealso> 标记中为方法重载创建 cref？

如何对我的代码进行 XML 注释，以便我指向类似的内容而不是每个单独的方法？计算哈希重载

基本上，您输入什么，cref以便它引用类似于 MSDN 的方法重载页面？

基本上，我有以下内容：<see cref="NotifyCollectionChangedEventArgs"/>请参阅我的 XML 注释中的标记。ReSharper 声明它是一个模棱两可的参考，并建议我将它作为绝对路径给出，所以我改用<see cref="System.Collections.Specialized.NotifyCollectionChangedEventArgs"/>它，它仍然说它是一个模棱两可的参考。我不知道在同一个命名空间中有两个同名的类可能会发生什么？

任何人都知道为什么这会成为 ReSharper 的问题？我还没有对 Sandcastle 进行测试，看看它是否会抱怨，因为这台机器上还没有 Sandcastle，但我想知道这是否也会抱怨。

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

遵循vsdoc 文档的这些指南，我无法让智能感知对给定类型的数组正常工作。这是一些演示问题的代码

就在arrayOfMyType[0]我应该为 MyType 获得智能感知之后，但我没有。我还尝试了一个 for-in 循环，看看这是否会带来正确的智能感知，但事实并非如此。我应该注意到，对于arrayOfMyTypea 确实有适当的智能感知Array，如果我将它从 更改为Array，MyType那么我会得到正确的智能感知，但不是示例中评论Array的类型。MyType

目前我只能访问 pre-sp1 vs2010，所以我不确定他们是否修复了它的错误。

谁能告诉我如果

• 我写错了我的 vsdoc xml 评论
• 关于期望在该行获得 MyType 的智能感知，我是否正确
• 上述片段的智能感知适用于 vs2010 sp1

在 Visual Studio 中，可以将 xml 注释添加到方法/类中以提供文档。请参阅http://msdn.microsoft.com/en-us/magazine/cc302121.aspx。

Visual Studio 从这些 xml 注释生成文件并导出它们，因此它们肯定可以访问。

我的问题是，是否有某种类可以让程序在运行时访问 xml 文本？（我认为蛮力的方法是解析导出的文件，但这不是一个很好的解决方案）

我想这样做的原因是因为我正在为一个更大的程序制作一种帮助程序，所以我想将 xml 注释输出到屏幕上。我通过反射获得了属性名称，那么有没有办法将名称反馈给某个类并获取 xml 文档？

我已经尝试搜索，但我找不到任何东西。我可能措辞不好。这可能吗？

可能重复：
WCF 服务中未出现 XML 注释

感谢 WCFExtras，WCF 方法的 XML 注释出现在生成的 .wsdl 文件中。现在的问题是，当我在客户端代码（代理）中调用方法时，没有出现 XML 注释。

有人知道如何使 xml 注释出现在客户端代码中，或者一种从 .wsdl 文件中提取注释并与客户端代码关联的方法吗？

谢谢！

这是一个例子：

ArgumentNullException 的 2 个不同原因。MSDN 的String.Format 示例显示了FormatException. 那么，是否这样做：

或其他方式？

我正在使用 XmlDocument 来解析 xml 文件，但似乎 XmlDocument 总是将 xml 注释作为 xml 节点读取：

我的 C# 代码

xml文件

.NET 不应该跳过 XML 注释吗？

当您在 C# 中创建 XML 注释并折叠它时，您只会看到：

但是在 VB 中你可能会看到

在尝试调试类时，在您的代码上添加该行会引入大量不需要的噪音。有什么方法可以关闭 VB 的 xml 评论预览？

与我之前的问题有关。如果我定义一个接口，我会评论它的成员。然后我不会评论实现类的实现，除非原始评论不再有效。

Resharper 对此很好，Visual Studio 声称这是一个警告。

重要的是，当您使用它们时，继承的评论会通过智能感知显示，这几乎是我唯一真正关心的问题。

您对此有何看法？

谢谢