问题标签 [xml-comments]

我正在访问一些旧代码，并且有很多事件是手动声明的，而不是使用 EventHandler<T>，如下所示：

一切都很好，直到我开始使用 sandcastle 来记录库，因为它找不到由事件声明生成的私有已添加字段的任何 XML 注释。我想尝试解决这个问题，但我想做的是：

• 让沙堡忽略自动生成的私有字段，而不告诉它完全忽略所有私有字段

或者

• 获取为私有字段生成的 XML 注释

有没有什么方法可以在不重构代码的情况下实现这一点：

我们有一个 C# 项目，由于历史原因，它在同一代码中同时使用了 Doxygen 和 Visual Studio 样式的注释。有没有人尝试过系统地将一种标准转换为另一种标准，最好是通用 XML 子集？

我想编写一个涵盖最常见功能的脚本不会太难，但我不想重新发明轮子。

根据这篇文章，可以获得多行 XML 注释——而不是使用///，使用/** */。这是我对多行注释的解释，以及我想要发生的事情：

但是，当我使用此表单时，当我将鼠标悬停在我的代码中的类名上时弹出的工具提示是单行的，即看起来就像我写的评论是这样的：

这种行为实际上仍然可能在 VS2008 中吗？

编辑

gabe 指出我误解了“多行”的含义，我实际上需要使用<para>或<br>获得我想要的效果。我继续使用<br>，因为我想控制换行符发生的位置，即

当我在我的代码中查看该类的工具提示时，所有内容仍以一行结束... WTH？我在这里做错了吗？

更新

好的，我继续尝试了<para>每一行的标签，这很有效。不知道为什么<br/>不。

我无法理解使用 XML 注释的优点。我知道它们可以转换为代码外部的漂亮文档，但同样可以使用更简洁的 DOxygen 语法来实现。我认为 XML 注释是错误的，因为：

1. 它们通常混淆了注释和代码。（它们更难被人类阅读）。
2. 可以在单个屏幕上查看更少的代码，因为“summary”和“/summary”需要额外的行。
3. （已删除）

那么可能是什么原因，为什么在 .NET 中首选 XML 而不是简单的 DOxygen 语法？

我正在尝试为我的 C# 方法上的 XML 注释构建一个列表。

我正在使用以下文档，但是其中的列表实现对我不起作用。我正在使用 Visual Studio 2008 和 .net 3.5。

http://msdn.microsoft.com/en-us/magazine/cc302121.aspx

如何在 C# 中使用 XML 注释构建列表？

这是我当前的 XML 代码。para 标记工作正常，但是没有生成列表。

我有一个给定的 XML 文档（结构无法更改），并希望获得写在节点上方的注释。该文档如下所示：

所以评论是可选的，但如果有的话，我想得到每个属性上面的评论。使用/*/comment()[n]会给我评论n，但是对于n = 2，我自然会得到第三个属性的评论，所以属性和评论之间没有联系有什么想法吗？谢谢

我想在web.config文件中添加评论，如下所示：

有没有办法以这种方式放置评论，使用服务器端评论之类的<% %>东西？

我在一个团队中工作，我们在 StyleCop 中使用广泛的规则集，我想知道对于这样的工具停止有用并开始变得烦人的一般观点是什么想法。我们还使用 GhostDoc，因此代码中充满了 XML 注释，这使得代码更难阅读和审查。我对 XML 注释没有任何问题，并且发现它们在某些地方非常有用，但是每个字段和属性都真的需要它们吗？

我们有一个令人钦佩的目标，“每个项目在构建时必须有 0 个警告”，但这个目标肯定需要违反合理的 StyleCop 规则集，否则宝贵的时间会浪费在“修复”StyleCop 警告的原因上。

对此有何想法？

编辑 我现在实际上想知道像 stylecop 这样的工具的论点是什么？为什么不放弃它，让合理的编码标准和良好的代码审查来处理剩下的事情呢？尤其是在一个优秀的胜任团队中？当然，获得 0 个警告的任务实际上会增加价值，因为所有警告都是相关的。

我认为 GhostDoc 的唯一优势是它可以为您从头开始编写 XML 注释节省几秒钟的时间。我认为您不应该在不编辑的情况下接受生成的评论——这可能会适得其反。

这是 GhostDoc 生成的 xml 注释所满足的 Stylecop 规则（SA1642：ConstructorSummaryDocumentationMustBeginWithStandardText）的组合 - 是否在一天结束时添加任何值？

我有 WCF 服务并评论我的运营合同如下：

但是，我在上面的 3 个正斜杠中添加的 XML 注释/// 没有出现在使用它的客户端应用程序的工具提示中，这是标准的 WCF/Web 服务功能吗？他们永远不会出现吗？或者有没有办法让它们出现？

正如标题所说，我的 XML 自动注释功能（/// 或 '''）已停止工作！

花了半个小时试图在工具/选项/环境中找到它，谷歌搜索它，重新启动等仍然没有运气:-(

请问有谁知道在哪里？