问题标签 [xml-comments]

是否有任何 C# 代码分析工具可以验证 XML 注释中的异常是否在调用链中的某处得到处理？

假设只有需要专门处理的异常是 xml 注释的，这将非常有用。

我尝试使用以下代码加载 XML 文件：

当文件包含这样的注释时：

XmlSerializer 返回类似的错误

意外的节点类型注释。ReadElementString 方法只能在内容简单或为空的元素上调用

当我在文件中删除此评论时，它工作正常。

我不知道问题出在哪里，有什么想法吗？

考虑这段 XML：

有什么办法可以注释掉MouseDoubleClick="item_DoubleClick"吗？此尝试失败：

xml 代码注释中是否有文件引用标签？该文件是一个 sql 脚本文件。只是想知道是否有比这样更好的方法

我对应该在哪里应用我的 XML 注释很感兴趣。我应该在接口中添加更通用的 XML 注释，在实现类中添加更具描述性的注释吗？像这样：

<param>为了简单起见，我没有包括在内。

这是评论的好习惯还是有不同的方式？我只是跳过评论界面吗？

我有以下内容，但我不确定如何在我的 XML 评论中正确引用它：

所以，我的猜测是<seealso cref="M:MyNamespace.FooExtensions.FooX{T}(this Nullable{T} foo)"/>，但如果这是正确的，我不是 100%。有人知道吗？

哦，我有 ECMA PDF 文档，但即便如此，我仍然无法真正弄清楚。

用于生成 API 文档的工具是否有一种标准方式来处理部分类的 XML 样式注释？基本上，一个人应该如何评论一个部分类/方法，以便生成的帮助文档不会被破坏？这个问题可能因使用的工具而异，在这种情况下，我猜最重要的两个工具是：

• Visual Studio 的内置方法来创建 XML 文档
• 微软的沙堡

我不希望我的 XML 文档变得时髦

基本上，何时真正需要（如果有的话）使用完全限定的 xml，请参阅参考：

此外，如何引用 .NET Framework 对象？

我了解完全合格的项目将始终允许 Microsoft 的 Sandcastle 正确链接事物，但是是否有必要使所有内容都完全合格？

旁注：Microsoft Sandcastle 是否能够链接到 .NET Framework 帮助文件，或者我是否通过引用来浪费时间<see cref="T:System.Collections.Generic.ICollection{T}"/>？

代码：

我的猜测是：

但是，我不确定。ECMA 指南没有帮助区分，所以我想我正在寻找我的猜测是正确的保证。

我知道，如果您///在类、字段、方法或属性之上，Visual Studio 将开始为您建立 XML 样式的注释。

但是，我在哪里可以为我的命名空间和/或库添加 XML 注释...

例如：

• .NET 框架类库
  • System.Collections 命名空间
    1. System.Collections 命名空间
    2. System.Collections.Concurrent 命名空间
    3. ...

我不确定这些页面是手动创建的，还是通过在适当位置添加的 XML 样式注释自动创建的？