我正在尝试改进我的代码文档,并决定仔细研究 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/