visual studio 2010 - vb.net: Using <see> Tags in XML comments -


i'm trying improve code documentation , decided give xml-comments closer look.

if i'm not mistaken, <see> tag should allow create clickable "links" or references other parts of code.

pe:

public class form1      ''' <summary>   ''' something.   ''' </summary>   private sub aaa()       'do   end sub      ''' <summary>   ''' calls <see cref="aaa"/>.   ''' </summary>   private sub bbb()       aaa()   end sub    end class 

this should create clickable link "aaa" in documentation of "bbb".

the xml-code compiles fine, intellisense helps choosing reference, in objectbrowser doesn't work! reference "aaa" dead text.

do have ideas on this? neat little feature if worked.

(i'm working on vs2010premium)

in visual studio 2015, see tag cause hyperlinks referenced objects appear within intellisense views. object viewer support these hyperlinks still missing.

the following example demonstrates intellisense functionality (vb.net):

''' <summary> ''' gets collection of source xml files.  see <see cref="imbuddy.collections.imexmlfilepaths"/> ''' </summary> ''' <returns>see <see cref="imbuddy.collections.imexmlfilepaths"/></returns> public readonly property sourcexmlfiles collections.imexmlfilepaths 

Comments

Popular posts from this blog

java - UnknownEntityTypeException: Unable to locate persister (Hibernate 5.0) -

python - ValueError: empty vocabulary; perhaps the documents only contain stop words -

ubuntu - collect2: fatal error: ld terminated with signal 9 [Killed] -