问题标签 [xml-documentation]

我正在使用 Visual Studio 2005 (VS.8.0)，我希望强制要求所有类成员，而不仅仅是公共成员，都被记录在案。虽然设置 Visual Studio 以在未记录公共、受保护或内部受保护成员时生成警告很简单，但我正在寻找一种方法让私有和内部成员抛出同样的警告。有什么建议么？

注意：我使用的是 4 级警告，将警告视为错误，并设置了生成 XML 标志。

假设我有一个这样定义的附加属性：

我可以为属性标识符 ( MyPropertyProperty) 和访问器 ( GetMyPropertyand SetMyProperty) 编写文档，但我不知道将MyClass.MyProperty 附加属性的文档放在哪里，因为它不是实际的代码元素。

MSDN 库包含此类文档（参见示例Grid.Row），因此它必须是可能的......

我应该将附加属性的 XML 文档注释放在哪里？

如果我有这两种方法

并以不同的方法编写这段 xml 文档

我得到一个蓝色波浪Get线，说它是一个不明确的参考 'Get'。这是真的，但我希望它引用两者。这样做的正确方法是什么？还是我应该只引用一个方法重载？

我有一个使用xml 注释的 C# 项目。我通过Sandcastle Help File Builder使用Sandcastle从它们制作 chm 文件。该项目中的成员函数之一使用了嵌入式资源。我想在帮助文件中引用它。似乎沙堡不支持这一点，但它解析的 xml 文档文件支持。我这样说是因为下面的例子

如果我编译该代码并从生成的 xml 文档中编译一个 chm，我会在构建日志中得到以下内容：

备注部分是：

如果我按照ReSharper的Agent Smith的建议进行操作并将<see/>元素更改为构建日志会说：<see cref="Resources.TextFile"/>

并且 chm 的备注部分更改为：

所以我的问题是第一部分：

1. 我使用<see/>元素来引用资源是否正确？
2. 有没有办法让沙堡引用它生成的 chm 文件中的嵌入式资源？

我有一些想要记录的 XML 文件和模式。该项目的所有内容都使用 NetBeans UML 模型、Microsoft Word 文档、Microsoft Excel 电子表格和 Microsoft Visio 绘图进行了记录。我是自我文档的粉丝，但这不是我的选择——必须制作外部文档。如何使用这些工具以图形方式描述 XML 文件和模式？

目前，我工作的文档处于某种状态。没有任何地方足够接近它，并且确实存在的文档分散在许多word文档中，因此很难找到任何东西。

我正在尝试采取一些主动并对其进行改进，我认为第一件事是找到一种更好的格式来编写文档：

• 我的想法是，文档应该以一系列短文（MSDN / Html 帮助风格）的形式组织起来，并以合适的树形式组织起来：
  • 最好能够生成一个独立的 Html-Help 样式包以随应用程序一起提供
  • 以及能够制作一个 MSDN 风格的网站，作为那些懒得看 CD 的人的参考。
  • 搜索当然是必须的
• 它至少需要相当容易更新——如果有一个 17 步的过程来更新已发布的文档，那么进行简单的更改就会显得工作量太大，而且没有人会费心去更新它。
• 该文档本质上是技术性的，因此理想情况下，能够包含从嵌入在 C# 代码中的 Xml 文档等生成的文档会很好。然而，这绝对是一个附带要求——目前很少有有用的 Xml 文档存在，只是我计划在未来修复它。
• 出于同样的原因，能够处理附件（代码示例等）之类的东西通常很好处理不好。

是否有适合此类文档的项目或语言？

在不同的 .dll 中使用该方法/类等时，不会显示注释。

有谁知道将 Javadoc 注释转换为 C# 文档注释的工具？

在记录 XML 文件的结构时...

我的一位同事在 Word 表中执行此操作。

另一个将元素粘贴到 Word 文档中，并带有如下注释：

首选这些方法中的哪一种？有没有更好的办法？

是否有其他选项不需要第三方 Schema Documenter 工具进行更新？

我GhostDoc用于我的代码的 XML 文档，它有一个我经常使用的简洁的“自动文档”功能，所以现在我在枚举中使用它，它想出了一些我不知道的奇怪哈希码很明白。

它是干什么用的？看起来有点像这样：

{35A90EBF-F421-44A3-BE3A-47C72AFE47FE}