【问题标题】:Visual Studio Intellisense for cref's in Xml Documentation用于 Xml 文档中 cref 的 Visual Studio Intellisense
【发布时间】:2011-10-06 01:55:55
【问题描述】:

当您在 Visual Studio(我使用的是 2010)中为 C# 方法创建 XML 文档时,您会收到 Intellisense 支持以创建各种 XML 标记,例如 see、paramref 等。另一方面,当您添加aa cref 属性你必须使用一个,我认为是描述类型的复杂格式。当您有许多泛型时,这是最糟糕的。

我正在寻找的内容如下。如果您在 see 元素中设置 cref 属性,您将拥有一个 Intellisense 类列表,这些列表与您目前输入的内容相匹配,然后输出必要的正确类型描述。或者,当您在 paramref 元素上设置 cref 属性时,您会收到该方法的参数列表。

有人知道 Visual Studio 的某种插件可以为这些 cref 属性提供智能感知吗?

【问题讨论】:

  • 它本身不是一个加载项,但切换到 VB.NET 会得到这个。 VB.NET IDE 完全支持 cref 属性和其他几个属性的 IntelliSense 自动完成。这是 C# IDE 缺乏的另一件事,这让我一直感到沮丧。

标签: c# visual-studio visual-studio-2010 intellisense xml-documentation


【解决方案1】:

我最近一直在编写大量 XML 文档,我认为 ReSharper 通过其扩展 IntelliSense Code Completion 功能提供了您正在寻找的功能 - 我一直在使用它。 Quick Documentation 功能在编写文档时也不容忽视 - 有了它,您可以看到 XML 文档在编译为 html/chm 时的实际样子,并且它会实时更新,因此,如果我在“快速文档”窗口打开时更改文档中的某些内容,我会看到它自动更改 - 对格式化等非常有帮助。

如果您将 Agent Smith 添加到组合中(显然,它只能作为 ReSharper 的附加组件),它可以添加一些方便的拼写检查XML 评论验证 em>、命名约定检查和一些简单的评论重排(如果您特别关注保持在一定数量的字符/行内)(前两个可能是最有用的,因为 ReSharper 提供了强制执行命名约定的能力) .

希望有帮助!

【讨论】:

  • 感谢您提供的线索;它让我在弄清楚如何构建 的过程中走了一半! (这是MyClass.op_Implicit,如果只定义了一个用户定义的转换,但我不知道如何区分两个或更多......
  • 所以,对于后代来说,MS says that the correct way<see cref="M:MyNamespace.MyType.op_Implicit(MyNamespace.MyType)~AnotherNamespace.ReturnType"/>,但是 R# 或 VS 或两者都不满意那个波浪号。哦,好吧。
猜你喜欢
  • 2013-11-02
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2022-08-16
  • 2022-01-21
  • 2012-07-14
  • 2010-09-21
相关资源
最近更新 更多