问题标签 [xml-comments]

基本上，在 MSDN 在线帮助中，我经常遇到“注意”部分，但我终生无法弄清楚如何获得相同的输出。显然没有<note>标签。有谁知道如何让这个工作？

IDictionary(TKey, TValue) — 在这个例子中，如果你进入备注部分，你会看到我在说什么。

我正在使用 Sandcastle 帮助文件生成器。

我继承了一个没有适当注释的 API，我正在努力改变它。

任何人都知道是否有某种机制可以为类或程序集的所有成员添加默认 XML 注释？（我记得在网络广播中看到过类似的东西，我认为他可能使用 PowerShell 脚本来实现这一点。）

这样我就可以避免很多重复的步骤，并且一切就绪，开始只写评论。

有人有更好的建议吗？

我正在创建一个库（C#、.Net），但我需要将它分发给多个国家的客户。当您将 XML 注释添加到您的类时，智能感知会从程序集中提取注释，并为您提供对方法、属性、参数等的很好的描述......

有什么方法可以制作我的程序集的本地化版本，以便 XML 注释使用本地语言，但只需要维护一份我的源代码副本？

我想要一个命令来自动换行 .NET 中的 XML 样式的注释。

例子：

如果他们能够做到这一点，我不介意购买一些商业 Visual Studio 插件。

我需要解析一个包含 xml 注释的文件。具体来说，它是使用 MS///约定的 ac# 文件。

从此我需要退出foobar，或者/// foobar也可以接受。（注意 - 如果您将 xml 全部放在一行上，这仍然不起作用......）

这是我所拥有的：

并输出：

但是我在跨多行工作的语法方面没有取得太大的成功。

（注意 - 我在 python 3.2 中测试了上述示例；它可以工作，但（根据我的问题）不打印任何值）

谢谢！

在 C# xml 注释中，下面的标签有什么区别？

我有一个包含 500 多个Missing XML Comment警告的项目。我知道我可以删除 XML 注释功能，或者将空的注释片段粘贴到任何地方，但我更喜欢通用解决方案，我可以在其中进行一项更改以禁用所有此类警告。

我刚才所做的就是把

或者

只是好奇这是否可能。

I am building help file for my library using Sandcastle Help File Builder. The library has three versions (.NET, Silverlight and Windows Phone 7) built from the same code base.

I would like to add platform icons next to method names and version information at the bottom of the help file pages. Something like on screenshots below. How can I add such information to my help file?

我正在使用 Visual Studio 2010 中的设置编辑器从 .NET 4 web.config 文件的部分添加/编辑/删除我的设置。

这是一个（相当模糊的）示例摘录来说明我的意思：

在上面的示例中，注释对于在现场手动编辑配置文件的任何人都是有用的（例如，一旦 Web 应用程序已部署到客户站点）。但是，如果我使用 VS 设置编辑器，那么每当我添加/编辑/删除设置时，注释都会丢失。

到目前为止，我想出了以下解决方法：

1. 我可以选择从不使用 VS 设置编辑器，但我必须告诉我的团队也避免使用它，而且总是有一次有人忘记了我们失去了所有的评论......

2. 我可以保留一份单独的 web.config 副本，其中包含一堆注释。然后我们将应用程序与配置文件的副本一起发送......（我不喜欢这个想法，因为这意味着我必须记住保持第二个副本是最新的并且我必须记住切换发布时的配置文件...太多要记住；太多可能会出错）。

3. 在开始标签上方添加评论似乎没问题，所以我可以将所有评论放在顶部。

我的问题是：解决这个问题的最佳方法是什么？你有什么建议吗？