Aracılığıyla paylaş


<summary>

Etiketin <summary> bir türü veya tür üyesini tanımlamak için kullanılması gerekir. Tür açıklamasına ek bilgiler eklemek için kullanın <remarks> .

Sözdizimi

/// <summary>description</summary>

Parametreler

description
Nesnenin özeti.

Açıklamalar

Etiketin <summary> metni, IntelliSense'teki türle ilgili tek bilgi kaynağıdır ve Nesne Tarayıcısı'nda ve Kod Açıklaması Web Raporu'nda da görüntülenir.

Bir dosyaya belge açıklamalarını işlemek için ile derleyin /doc .

Örnek

// xml_summary_tag.cpp
// compile with: /LD /clr /doc
// post-build command: xdcmake xml_summary_tag.dll

/// Text for class MyClass.
public ref class MyClass {
public:
   /// <summary>MyMethod is a method in the MyClass class.
   /// <para>Here's how you could make a second paragraph in a description. <see cref="System::Console::WriteLine"/> for information about output statements.</para>
   /// <seealso cref="MyClass::MyMethod2"/>
   /// </summary>
   void MyMethod(int Int1) {}

   /// text
   void MyMethod2() {}
};

Ayrıca bkz.

XML belgeleri