DemoClass

Here is the Source-Code for the Demo Libary-documentation:


Namespace DemoNamespace

    ''' <summary>
    ''' Demo Klasse
    ''' </summary>
    ''' <remarks></remarks>
    Public Class DemoClass

        ''' <summary>
        ''' Default Constructor
        ''' </summary>
        ''' <remarks></remarks>
        Public Sub New()

        End Sub

        ''' <summary>
        ''' Demo Event
        ''' </summary>
        ''' <param name="sender">Caller</param>
        ''' <param name="e">Eventargs</param>
        ''' <remarks>
        ''' So you can use the Event:
        ''' <example>
        ''' <code format="Csharp">
        ''' var DemoObj = new DemoClass();
        ''' DemoObj.DemoEvent += delegate(object sender, EventArgs e) 
        '''                      { 
        '''                         //Do Something in the Event
        '''                      };
        ''' </code>
        ''' <code format="VBNET">
        ''' Dim DemoObj = new DemoClass()
        ''' AddHandler Me.DemoEvent, Sub(sender, e)
        '''                             'Do Something in the Event
        '''                          End Sub
        ''' </code>
        ''' </example>
        ''' </remarks>
        Public Event DemoEvent(ByVal sender As Object, ByVal e As DemoEvnetArgs)

        ''' <summary>
        ''' Demo Field
        ''' </summary>
        ''' <remarks></remarks>
        Public DemoField As String = "String Field"

        ''' <summary>
        ''' Demo Property
        ''' </summary>
        ''' <value>A <see cref="String">String</see>-Value that should DemoProperty be</value>
        ''' <returns>The DemoProperty Value of <see cref="DemoClass">DemoClass</see> as Type <see cref="String">String</see></returns>
        ''' <remarks></remarks>
        Public Property DemoProperty As String = "String Property"

        ''' <summary>
        ''' Function with Param and reference to an Class in this Assembly
        ''' </summary>
        ''' <param name="pEnumParam">Enum Prameter</param>
        ''' <returns></returns>
        ''' <remarks></remarks>
        Public Function EnumFunction(ByVal pEnumParam As DemoEnum) As DemoEnum

        End Function


        ''' <summary>
        ''' Demo Sub with link to <paramref name="pSomePram">pSomePram</paramref> and a 
        ''' secound link to <paramref name="pSomePram">pSomePram</paramref>
        ''' </summary>
        ''' <param name="pSomePram">Its a Parameter</param>
        ''' <remarks>
        ''' Here some example for you
        ''' <example>
        ''' <code format="Csharp">
        ''' var DemoObj = new DemoClass();
        ''' DemoObj.DemoSub("This");
        ''' </code>
        ''' </example>
        ''' </remarks>
        ''' <exception cref="Exception">Some Exception Info</exception>
        Public Sub DemoSub(ByVal pSomePram As String)

        End Sub

        ''' <summary>
        ''' Demo Function with Link <paramref name="pMoreParam">pMoreParam</paramref> and text after
        ''' </summary>
        ''' <param name="pMoreMoreParam">This is a Parameter</param>
        ''' <param name="pMoreParam">And a Parameter, too</param>
        ''' <returns>A <see cref="String">String</see>-Value</returns>
        ''' <remarks></remarks>
        Public Function DemoFunction(ByVal pMoreParam As Integer, ByVal pMoreMoreParam As String) As String

        End Function

        ''' <summary>
        ''' Overloaded Function without Parameter
        ''' </summary>
        ''' <returns>A <see cref="String">String</see>-Value, too</returns>
        ''' <remarks></remarks>
        Public Function DemoFunction() As String

        End Function

        ''' <summary>
        ''' Sub with an Optional Parameter call <paramref name="Parameter">Parameter</paramref>
        ''' </summary>
        ''' <param name="Parameter">Optional Parameter</param>
        ''' <remarks></remarks>
        Public Sub DoSomething(Optional ByVal Parameter As String = "Default")

        End Sub

    End Class

    ''' <summary>
    ''' Demo Enum
    ''' </summary>
    ''' <remarks></remarks>
    <Flags()> _
    Public Enum DemoEnum

        ''' <summary>
        ''' Description Field1
        ''' </summary>
        ''' <remarks></remarks>
        Field1
        ''' <summary>
        ''' Description Field2
        ''' </summary>
        ''' <remarks></remarks>
        Field2
        ''' <summary>
        ''' Description Field3
        ''' </summary>
        ''' <remarks></remarks>
        Field3
        ''' <summary>
        ''' Description Field4
        ''' </summary>
        ''' <remarks></remarks>
        Field4

    End Enum

    ''' <summary>
    ''' DemoInterface
    ''' </summary>
    ''' <remarks></remarks>
    Public Interface IDemoInterface

        ''' <summary>
        ''' Event of the Interface
        ''' </summary>
        ''' <param name="sender">Event raiser</param>
        ''' <param name="e">Event args</param>
        ''' <remarks></remarks>
        Event DemoInterfaceEvent(ByVal sender As Object, ByVal e As DemoEvnetArgs)

        ''' <summary>
        ''' Property of the Event
        ''' </summary>
        ''' <value>String of the Property</value>
        ''' <returns></returns>
        ''' <remarks></remarks>
        Property DemoProperty As String

        ''' <summary>
        ''' Function of the Interface
        ''' </summary>
        ''' <returns>Returns a <see cref="String">String</see></returns>
        ''' <remarks></remarks>
        Function DemoFunction() As String

        ''' <summary>
        ''' Sub of the Interface
        ''' </summary>
        ''' <remarks></remarks>
        Sub DemoSub()

    End Interface

    ''' <summary>
    ''' This are the Event args for the DemoEvent
    ''' </summary>
    ''' <remarks></remarks>
    Public Class DemoEvnetArgs
        Inherits EventArgs

        ''' <summary>
        ''' Arg 1 of the Eventargs
        ''' </summary>
        ''' <value></value>
        ''' <returns></returns>
        ''' <remarks></remarks>
        Property Arg1 As String

        ''' <summary>
        ''' Constructor
        ''' </summary>
        ''' <param name="pArg1">Inital Value for Arg1</param>
        ''' <remarks></remarks>
        Sub New(ByVal pArg1 As String)
            Arg1 = pArg1
        End Sub

    End Class

End Namespace



This WikiPage was created with Codeplex WikiEditor

Last edited Jun 28, 2010 at 10:08 PM by SoftHai, version 3

Comments

No comments yet.