Поделиться через

<seealso> тег документации

  • Статья

С помощью тега <seealso> можно указать текст, который должен отображаться в разделе "См. также". Тег <see> позволяет задать ссылку из текста.

Синтаксис

/// <seealso cref="member"/>

Параметры

member
Ссылка на член или поле, которые доступны для вызова из текущей среды компиляции. Заключите имя в одинарные или двойные кавычки.

Компилятор проверяет, существует ли элемент кода, и разрешает member в имя элемента в выходных XML-данных. Компилятор выдает предупреждение, если он не находит member.

Сведения о создании ссылки на универсальный cref тип см. в разделе <see>.

Замечания

Скомпилируйте их для /doc обработки примечаний документации к файлу.

См. <summary> с примером использования <seealso>.

Компилятор MSVC пытается разрешить cref ссылки в одном проходе по комментариям документации. Если компилятор не находит символ при использовании правил подстановки C++, он помечает ссылку как неразрешенную.

Пример

В следующем примере неразрешенный символ ссылается на cref. XML-комментарий для объекта cref A::Test хорошо сформирован: <seealso cref="M:A.Test" /> Тем не менее, cref становится<seealso cref="!:B::Test" />B::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-документация