DocumentableItem.Documentation Eigenschaft

Definition

Namespace:

System.Web.Services.Description

Assembly:

System.Web.Services.dll

Ruft die Textdokumentation für die Instanz von DocumentableItem ab oder legt diese fest.

C#

public string Documentation { get; set; }

Eigenschaftswert

String

Eine Zeichenfolge, die die Dokumentation für das DocumentableItem darstellt.

Beispiele

Im folgenden Codebeispiel wird eine typische Verwendung der Documentation -Eigenschaft veranschaulicht.

C#

using System;
using System.Web.Services.Description;

class DocumentableItemSample
{
   public static void Main()
   {
      ServiceDescription myServiceDescription = ServiceDescription.Read("MathService_cs.wsdl");
      Console.WriteLine("Documentation Element for type is ");
      PrintDocumentation(myServiceDescription.Types);
      foreach(PortType myPortType in myServiceDescription.PortTypes)
      {
         Console.WriteLine("Documentation Element for Port Type {0} is ",myPortType.Name);
         PrintDocumentation(myPortType);
      }
      foreach(Binding myBinding in myServiceDescription.Bindings)
      {
         Console.WriteLine("Documentation Element for Port Type {0} is ",myBinding.Name);
         PrintDocumentation(myBinding);
      }
   }
   // Prints documentation associated with a wsdl element.
   public static void PrintDocumentation(DocumentableItem myItem)
   {
      Console.WriteLine("\t" + myItem.Documentation);
   }
}

Hinweise

In einer abgeleiteten Klasse stellt diese Eigenschaft die Textkommentare dar, die einem Element des XML-Webdiensts hinzugefügt werden. Die Standardimplementierung ist eine leere Zeichenfolge ("").

Gilt für: