DocumentableItem.Documentation Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets or sets the text documentation for the instance of the 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
Property Value
A string that represents the documentation for the DocumentableItem.
Examples
The following code example demonstrates a typical usage of the Documentation property.
#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
Remarks
In a derived class, this property represents the text comments added to an element of the XML Web service. The default implementation is an empty string ("").
Applies to
Feedback
https://aka.ms/ContentUserFeedback.
Kommer snart: I hele 2024 udfaser vi GitHub-problemer som feedbackmekanisme for indhold og erstatter det med et nyt feedbacksystem. Du kan få flere oplysninger under:Indsend og få vist feedback om