Visual Studio Intellisense for Xml文档中的cref

时间:2011-07-15 11:16:13

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

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

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

有没有人知道Visual Studio的某些插件为这些cref属性提供Intellisense?

1 个答案:

答案 0 :(得分:4)

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

如果你将Agent Smith添加到混合中(显然只作为ReSharper的附加组件),它可以添加一些方便的拼写检查 XML注释验证,命名约定检查,以及一些简单的注释回复(如果您特别关注保持在一定数量的字符/行内)(前两个可能是最有用的,因为ReSharper提供了强制命名的能力惯例)。

希望有所帮助!