DocumentableItem.Documentation Свойство
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Возвращает или устанавливает текст документации для экземпляра DocumentableItem.
public:
property System::String ^ Documentation { System::String ^ get(); void set(System::String ^ value); };
public string Documentation { get; set; }
member this.Documentation : string with get, set
Public Property Documentation As String
Значение свойства
Строка, которая представляет документацию для объекта DocumentableItem.
Примеры
В следующем примере кода демонстрируется типичное использование Documentation свойства.
#using <System.dll>
#using <System.Xml.dll>
#using <System.Web.Services.dll>
using namespace System;
using namespace System::Xml;
using namespace System::Web::Services::Description;
using namespace System::Collections;
// Prints documentation associated with a wsdl element.
void PrintDocumentation( DocumentableItem^ myItem )
{
Console::WriteLine( "\t {0}", myItem->Documentation );
}
int main()
{
ServiceDescription^ myServiceDescription = ServiceDescription::Read( "MathService_cpp.wsdl" );
Console::WriteLine( "Documentation Element for type is " );
PrintDocumentation( myServiceDescription->Types );
IEnumerator^ myEnum = myServiceDescription->PortTypes->GetEnumerator();
while ( myEnum->MoveNext() )
{
PortType^ myPortType = safe_cast<PortType^>(myEnum->Current);
Console::WriteLine( "Documentation Element for Port Type {0} is ", myPortType->Name );
PrintDocumentation( myPortType );
}
myEnum = myServiceDescription->Bindings->GetEnumerator();
while ( myEnum->MoveNext() )
{
Binding^ myBinding = safe_cast<Binding^>(myEnum->Current);
Console::WriteLine( "Documentation Element for Port Type {0} is ", myBinding->Name );
PrintDocumentation( myBinding );
}
}
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);
}
}
Imports System.Web.Services.Description
Class DocumentableItemSample
Public Shared Sub Main()
Dim myServiceDescription As ServiceDescription = _
ServiceDescription.Read("MathService_vb.wsdl")
Console.WriteLine("Documentation Element for type is ")
PrintDocumentation(myServiceDescription.Types)
Dim myPortType As PortType
For Each myPortType In myServiceDescription.PortTypes
Console.WriteLine("Documentation Element for Port Type {0} is ", myPortType.Name)
PrintDocumentation(myPortType)
Next myPortType
Dim myBinding As Binding
For Each myBinding In myServiceDescription.Bindings
Console.WriteLine("Documentation Element for Port Type {0} is ", myBinding.Name)
PrintDocumentation(myBinding)
Next myBinding
End Sub
' Prints documentation associated with a wsdl element.
Public Shared Sub PrintDocumentation(myItem As DocumentableItem)
Console.WriteLine(ControlChars.Tab + myItem.Documentation)
End Sub
End Class
Комментарии
В производном классе это свойство представляет текстовые комментарии, добавленные в элемент веб-службы XML. Реализация по умолчанию — пустая строка ("").