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

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

  • Статья

Тег <c> указывает, что текст в описании должен быть помечен как код. Чтобы определить несколько строк в качестве кода, используйте тег <code>.

Синтаксис

/// <c>text</c>

Параметры

text
Текст, который нужно указать в качестве кода.

Замечания

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

Пример

// xml_c_tag.cpp
// compile with: /doc /LD
// post-build command: xdcmake xml_c_tag.xdc

/// Text for class MyClass.
class MyClass {
public:
   int m_i;
   MyClass() : m_i(0) {}

   /// <summary><c>MyMethod</c> is a method in the <c>MyClass</c> class.
   /// </summary>
   int MyMethod(MyClass * a) {
      return a -> m_i;
   }
};

См. также

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