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


<seealso> (Visual C++)

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

<seealso cref="member"/>

Параметры

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

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

    Дополнительные сведения о создании cref-ссылки на универсальный тип см. в разделе <see> (Visual C++).

Заметки

Чтобы обработать и сохранить комментарии документации в файл, при компиляции необходимо использовать параметр /doc.

В разделе <summary> (Visual C++) пример использования <seealso>.

Компилятор C Visual C++ пытается разрешить ссылки cref в одном прохождении через документирующие комментарии.Поэтому при использовании правила поиска C, C++, символ не найден компилятором, ссылка будет помечена как не разрешен.

Пример

В следующем примере, неразрешенный символ связан с cref.Комментарий XML для cref в B::Test является <seealso cref="!:B::Test" />, тогда как ссылка на A::Test <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 (Visual C++)