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

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

  • Статья

Тег <exception> служит для указания возможных исключений. Этот тег применяется к определению метода.

Синтаксис

/// <exception cref="member">description</exception>

Параметры

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

Заключите имя в одинарные или двойные кавычки.

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

description
Описание.

Замечания

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

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

Пример

// xml_exception_tag.cpp
// compile with: /clr /doc /LD
// post-build command: xdcmake xml_exception_tag.dll
using namespace System;

/// Text for class EClass.
public ref class EClass : public Exception {
   // class definition ...
};

/// <exception cref="System.Exception">Thrown when... .</exception>
public ref class TestClass {
   void Test() {
      try {
      }
      catch(EClass^) {
      }
   }
};

См. также

XML-документация