vb.net:在 XML 注释中使用 <see> 标签

标签 vb.net visual-studio-2010 xml-documentation

我正在尝试改进我的代码文档,并决定仔细研究 XML 注释。

如果我没记错的话,<see>标签应该允许创建可点击的“链接”或对代码其他部分的引用。

pE:

Public Class Form1  

  ''' <summary>
  ''' Does something.
  ''' </summary>
  Private Sub aaa()
      'do something
  End Sub  

  ''' <summary>
  ''' Calls <see cref="aaa"/>.
  ''' </summary>
  Private Sub bbb()
      aaa()
  End Sub  

End Class

这应该在“bbb”的文档中创建一个指向“aaa”的可点击链接。

xml 代码编译得很好,智能感知甚至有助于选择要引用的内容,但在对象浏览器中它不起作用!对“aaa”的引用只是死文本。

您对此有什么想法吗?如果它有效的话,这将是一个很棒的小功能。

(我正在使用 VS2010Premium)

最佳答案

在 Visual Studio 2015 中,see 标记将导致引用对象的超链接出现在 IntelliSense View 中。对象查看器仍然缺少对这些超链接的支持。

以下示例演示了 IntelliSense 功能 (vb.net):

''' <summary>
''' Gets the collection of source XML files.  See <see cref="imbuddy.Collections.ImeXmlFilePaths"/>
''' </summary>
''' <returns>See <see cref="imbuddy.Collections.ImeXmlFilePaths"/></returns>
Public ReadOnly Property SourceXmlFiles As Collections.ImeXmlFilePaths

关于vb.net:在 XML 注释中使用 <see> 标签,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/32198649/

相关文章:

c# - 系统.Enum.GetValues : In C# not the same as in VB?

VB.NET:如何在 xml 文档中引用通用类和方法

c# - 如何在 C# .NET 文档中添加换行符

c# - 如何将对象转换为在运行时提取的类型

c# - 检测简单的触摸手势

c# - 在 Visual Studio C# 中设置 cpu 架构类型的重要性

visual-c++ - VC++ 2010 想要链接我什至没有指定的 boost 库

c# - 正确记录 C# 事件委托(delegate)

asp.net - 获取文本框的先前值asp.net vb.net

visual-studio - 有没有一种方法可以防止Visual Studio 2010在ASP.NET MVC View 中格式化C#代码?