Results 1 to 2 of 2

Thread: how to create help menu ?

  1. #1

    Thread Starter
    Addicted Member
    Join Date
    Apr 2013
    Posts
    198

    how to create help menu ?

    k i have just finished my vb.net 2008 application and i wanted to make a help section for the users. i have downloaded sandcastle but it seems like i need to deal with xml too and its something i havent used before. so please suggest ways to make help documents for my application.thanks

  2. #2
    Super Moderator dday9's Avatar
    Join Date
    Mar 2011
    Location
    South Louisiana
    Posts
    9,684

    Re: how to create help menu ?

    I've never used sandcastle before, but if you are referring to XML comments then if you automatically type three comments(''') then Visual Studios will automatically generate the XML comment for you.

    Here is an example. Assume for a second that you have a Double property named Value:
    Code:
    Private _value As Double
    Public Property Value As Double
        Get
            Return _value
        End Get
        Set (ByVal value As Double)
            _value = value
        End Set
    End Property
    If you wanted to add an XML comment, add the 3 apostrophes before the property name it this will automatically be generated:
    Code:
    Private _value As Double
    ''' <summary></summary>
    ''' <returns></returns>
    ''' <remarks></remarks>
    Public Property Value As Double
        Get
            Return _value
        End Get
        Set (ByVal value As Double)
            _value = value
        End Set
    End Property
    Then I'd add document everything in the XML comment:
    Code:
    Private _value As Double
    ''' <summary>Gets or sets the value of the class.</summary>
    ''' <returns>Double.</returns>
    ''' <remarks>Super cool property dude!</remarks>
    Public Property Value As Double
        Get
            Return _value
        End Get
        Set (ByVal value As Double)
            _value = value
        End Set
    End Property

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •  



Click Here to Expand Forum to Full Width