问题标签 [xml-comments]

好吧，标题问了一切。

我有 Sandcastle 帮助文件生成器 GUI。我可以生成帮助文件，但我想知道除了重新编译整个帮助文件之外，是否有更快的方法来查看结果。

我询问了 Sandcastle，因为我尝试过的其他提供预览功能的工具不会像 Sandcastle 那样将帮助文件编译成确切的规范。他们中的大多数都需要完全合格的参考资料，这很麻烦。

顾名思义，我不知道如何引用字典索引器。这里有什么帮助吗？:)

仅供参考，我试过：

如果我有以下功能：

我如何在seealso构造中引用它？

抱怨“不能在属性值中使用字符 '<'”。将 '<' 和 '>' 更改为 '{' 和 '}' 可以工作，但会使其打开泛型参数。

我有一个包含 3 个不同项目的 Visual Studio C# 解决方案。在每个项目中，我都使用 xml-comments 对所有代码进行了注释。如果我希望将注释构建到 xml 中，我必须为每个项目指定一个输出文件。是否可以将所有 xml 注释构建到一个文件中？

我正在尝试为我的代码创建文档，并且我正在使用 xml-comments。当一个类被记录如下：

xml 文件将包含 mainWindow 的以下条目：

T:CaseManager.mainWindow 中的 T 告诉我它是“类型：类、接口、结构、枚举、委托”，其余的告诉我类型的名称空间和名称。无论如何让我指定它是哪种类型。例如，为类编写 T:C:...，为接口编写 T:I:... 等等。

我写了一个方法，例如：

但是当我使用这种方法时，Visual Studio（我使用的是 VS 2010）只是显示“ A method having xml-comments This comment could be... ”不是一个完整的文档。

有显示它的选项吗？

更新图片：

谢谢 ：-）

我正在尝试在 VB.Net 中的 XML 注释中添加换行符。我读过另外两篇关于 C# 的文章，

C# 中的 XML 多行注释 - 我做错了什么？

为 Intellisense 的注释添加换行符

但是建议的<para>或<br/>标签不起作用。这个，

仍然看起来像这样：

我怎样才能使这项工作？

我知道如何使用代码中的 <include> 关键字来引用外部注释文件中的成员。就像是：

但是，我在 Comments.xml 文件中有重复的成员，我想将它们拆分出来并在 Comments.xml 文件本身中引用。例如，它可以是多次使用的参数定义。

我已经尝试过与上述相同的格式，但它不起作用。有任何想法吗？

ETA：根据这篇博文“原因 3”，它应该使用完全相同的语法，所以我不确定为什么它不适合我。如果我查看 Visual Studio 生成的 xml 文件，则没有生成错误。事实上，它看起来甚至没有尝试包含该成员，因为我原来的“包含”行仍在其中（但“路径”部分出现在“文件”部分之前）。

ETA2：我必须修复上述博客文章中的 c# 示例，以将包含包含拆分为单独的 xml 文件，否则在编译时会生成 stockoverflow。
但是，我无法让它为我工作。我正在使用 VB，我在 2008 年和 2010 年对其进行了测试——两​​者都是速成版。这意味着语法不同，或者功能未在 Visual Studio 的 VB 版本中实现。

在指定摘要标签注释时，标签是否有办法<param>注意参数是可选的，即。客户端可以提供一个值或空值，例如：<param name="Mime" optional="true">.

谷歌搜索未能为我提供一组属性或允许值。

谢谢

ETA：Visual Studio 2010 VB Express 版本表现出相同的行为。
ETA：Visual Studio 2010 C# Express 版本没有表现出相同的行为。

在 VisualStudio 2008 VB Express 版本中，我指定了以下注释：

如果我编译文件并检查 .xml，我会看到注释包含在与我指定的相反的顺序中，即。Part3 出现在 Part2 出现在 Part1 之前。

有谁知道为什么会这样？

预计到达时间：

附加行为：如果内联注释散布在外部包含之间，它们都会先写入 xml，然后再写入包含（以相反的顺序）！

请让有一个名为“关闭不直观的 xml 评论行为”的选项