XML文档中cref的Visual Studio Intellisense

8
当您在Visual Studio中为C#方法创建XML文档(我使用的是2010版本)时,您会收到Intellisense支持,用于创建各种XML标记,例如see、paramref等。另一方面,当您添加cref属性时,您必须使用一个我认为很复杂的格式来描述类型。当您有多个泛型时,情况就更糟了。
我需要的是如下内容。如果您在see元素中设置cref属性,则会出现与您输入的内容匹配的类的Intellisense列表,然后输出所需的正确类型描述。或者,当您在paramref元素上设置cref属性时,您将收到该方法参数的列表。
是否有人知道某种Visual Studio插件来提供这些cref属性的Intellisense?

它本身不是一个插件,但是转换到VB.NET将会让你得到这个功能。VB.NET IDE完全支持cref属性和其他几个属性的IntelliSense自动完成。这一点总是让我感到沮丧,因为C# IDE缺少了这个功能。 - Cody Gray
1个回答

4

最近我写了很多XML文档,我认为ReSharper的扩展智能感知代码完成功能提供了您正在寻找的功能 - 我一直在使用它。在编写文档时,也不要忽略快速文档功能 - 使用它,您可以看到将XML文档编译为html/chm后实际的效果,并且它会实时更新,因此如果我在Quick Documentation窗口中更改文档中的内容,我会立即看到更改 - 对于格式设置等非常有帮助。

如果你添加Agent Smith到混合物中(显然只能作为ReSharper的附加组件),它可以添加一些方便的拼写检查XML注释验证、命名约定检查和一些简单的注释重新格式化(如果你特别关心每行字符的数量)(前两个可能是最有用的,因为ReSharper提供了强制实施命名约定的能力)。希望这有所帮助!

谢谢你提供的线索,它让我成功解决了一半构建<see cref="User-Defined-Conversion">的问题!(如果只定义了一个用户定义的转换,则为MyClass.op_Implicit,但我无法区分两个或更多的转换... - Carl G
因此,为了后代,MS表示正确的方法<see cref="M:MyNamespace.MyType.op_Implicit(MyNamespace.MyType)~AnotherNamespace.ReturnType"/>,但是R#或VS或两者都不喜欢那个波浪号。 哦,好吧。 - Carl G

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接