Tag: xml comments

在XML文档中使用带字符的cref？: 可能重复：如何在xml文档中引用generics类和方法我一直在使用see cref标签，它工作得很好，但现在我需要在see cref中包含一个string []的通用列表，但是文档没有正确呈现。 /// A <see cref="List” /> that ……. 我认为它与有关，也许[] 这是允许的，是否有解决方法？

c＃Intellisense VS2013工具提示不显示XML注释（我试试全部）: 我阅读了有关intellisense问题的所有问题，但我的intellisense不起作用。 Visual Studio Ultimate 2013 我不使用任何扩展，如Resharper，ghostdoc等有关自定义类而非自定义类的所有XML文档文件都位于starter项目的/ bin文件夹中。（构建 – > 生成XML文档是ON ）我通过对象浏览器可以浏览所有文档 Intellisense不显示有关的工具提示信息。 NET类 / EF / Identity也是如此 Intellisense仅显示有关摘要自定义类的工具提示信息，但不显示参数/返回等。工具 – > 选项 – > 文本编辑器 – > C＃ – >选中参数信息和自动列表成员所以，我不知道错误在哪里：/如果有人知道我非常感激。谢谢你的时间

从代码注释中引用TFS工作项: 在Visual Studio（2012+）中，我想要一个从代码注释到TFS工作项的可点击引用。有没有一种简单的方法可以做到这一点，这也可能来自函数体内的注释（不是函数的摘要）？所以我想要这样的东西： /// /// Example of a summary /// static void Main() { int dummy = 1; //Should be 1 according to @Task1234 <- should be a hyperlink } 而不是这样的事情： /// /// Example of a summary, see Task 1234 . /// static void Main() { } 一些标签阅读材料：文档注释的推荐标签（C＃编程指南）

Visual Studio 2015缺少XML注释/文档: 它是我还是Visual Studio 2015中 System.Linq缺少的XML注释？因为我仍然可以在MSDN上找到它。但是在输入时，例如，这段代码： var list = new List(); list.Select( IntelliSense不提供System.Linq命名空间中任何类/方法/成员/扩展的注释/文档：点击（ Alt +） F12 进入 Enumerable上随机扩展方法的定义时，可以预览：我想我也没有注意到Visual Studio 2013中的文档。但我确实记得他们曾经在那里，也许是在Visual Studio 2012或之前？编辑：我忘了提到我在Visual Studio 2015中安装了Resharper 10 Ultimate。我还在Visual Studio 2013中安装了Resharper 8和9。

在.NET中使用XML注释的优点是什么？: 我无法理解使用XML注释的优点。我知道它们可以转换成代码外部的漂亮文档，但使用更加简洁的DOxygen语法也可以实现相同的目标。在我看来，XML注释是错误的，因为：它们总体上混淆了评论和代码。（它们更难以被人类阅读）。可以在单个屏幕上查看更少的代码，因为“summary”和“/ summary”需要额外的行。（已删除）那可能是什么原因，为什么XML在.NET中更受欢迎而不是简单的DOxygen语法？

使用C＃的XML注释cref属性和params语法: 在C＃中，我试图使用来引用包含params关键字的方法签名。我知道这会将参数列表转换为数组，但我甚至无法弄清楚如何在CREF属性中引用数组。我在搜索中找不到任何内容，也没有人知道任何想法。编译器在方括号上窒息。我已经尝试了各种不同的组合，使用花括号，使用Array类，但没有任何工作。有谁知道这个？

ConfigurationManager可以在Save（）上保留XML注释吗？: 我写了一个小实用程序，允许我为另一个应用程序的App.config文件更改一个简单的AppSetting，然后保存更改： //save a backup copy first. var cfg = ConfigurationManager.OpenExeConfiguration(pathToExeFile); cfg.SaveAs(cfg.FilePath + “.” + DateTime.Now.ToFileTime() + “.bak”); //reopen the original config again and update it. cfg = ConfigurationManager.OpenExeConfiguration(pathToExeFile); var setting = cfg.AppSettings.Settings[keyName]; setting.Value = newValue; //save the changed configuration. cfg.Save(ConfigurationSaveMode.Full); 这种效果很好，除了一个副作用。新保存的.config文件会丢失所有原始XML注释，但仅在AppSettings区域内。是否可以从原始配置文件AppSettings区域保留XML注释？如果您想快速编译并运行它，那么这是完整源代码的pastebin。

C＃中的XML多行注释 – 我做错了什么？: 根据这篇文章，可以获得多行XML注释 – 而不是使用/// ，使用/** */ 。这是我对多行注释的解释，以及我想要发生的事情： /** * * this comment is on line 1 in the tooltip * this comment is on line 2 in the tooltip * */ 但是，当我使用这个表单时，当我将鼠标hover在我的代码中时弹出的工具提示是单行的，即它看起来就像我写了这样的评论： /// /// this comment is on line 1 in the tooltip /// this comment is on line 2 in the tooltip /// […]