<seealso> (Visual C++)

 

For the latest documentation on Visual Studio 2017 RC, see Visual Studio 2017 RC Documentation.

The <seealso> tag lets you specify the text that you might want to appear in a See Also section. Use <see> to specify a link from within text.

<seealso cref="member"/>  

Parameters

member
A reference to a member or field that is available to be called from the current compilation environment. Enclose the name in single or double quotation marks.

The compiler checks that the given code element exists and resolves member to the element name in the output XML. The compiler issues a warning if it does not find member.

For information on how to create a cref reference to a generic type, see <see>.

Compile with /doc to process documentation comments to a file.

See <summary> for an example of using <seealso>.

The Visual C++ compiler will attempt to resolve cref references in one pass through the documentation comments. Therefore, if using the C++ lookup rules, a symbol is not found by the compiler the reference will be marked as unresolved.

In the following sample, an unresolved symbol is referenced in a cref. The XML comment for the cref to B::Test will be <seealso cref="!:B::Test" />, whereas the reference to A::Test is well-formed <seealso cref="M:A.Test" />.

// xml_seealso_tag.cpp  
// compile with: /LD /clr /doc  
// post-build command: xdcmake xml_seealso_tag.dll  
  
/// Text for class A.  
public ref struct A {  
   /// <summary><seealso cref="A::Test"/>  
   /// <seealso cref="B::Test"/>  
   /// </summary>  
   void MyMethod(int Int1) {}  
  
   /// text  
   void Test() {}  
};  
  
/// Text for class B.  
public ref struct B {  
   void Test() {}  
};  

XML Documentation

Show: