Solved

Adding guidance into classes for end users

Posted on 2014-09-18
2
189 Views
Last Modified: 2014-09-18
I would like to be able to include a little help into my properties and methods so the end user of the class knows what the property is for e.g
propertytip.jpg
You can see the advice : "Provides a mechanism for enumerating all...."
I would like to be able to introduce this kind of assistance into my own properties.

I struggled with finding an article on this on the web given the generic nature of 'creating help in properties classes .net'
but hopefully it is straightforward....
0
Comment
Question by:dgloveruk
2 Comments
 
LVL 12

Accepted Solution

by:
Ramkisan Jagtap earned 500 total points
ID: 40329863
At the start of the property or function you can add summary comments as belw:

''' <summary>
''' Returns the name of the code.
''' </summary>
Function GetName() As String
    Return "Something"
End Function

''' <summary>
''' Returns the number of times Counter was called.
''' </summary>
''' <value>Number of times Counter was called.</value>
Public ReadOnly Property Counter() As Integer
    Get
        counterValue += 1
        Return counterValue
    End Get
End Property


Reference: http://msdn.microsoft.com/en-IN/library/ms172669.aspx
0
 

Author Closing Comment

by:dgloveruk
ID: 40329874
Thank you Ramkisan
0

Featured Post

DevOps Toolchain Recommendations

Read this Gartner Research Note and discover how your IT organization can automate and optimize DevOps processes using a toolchain architecture.

Question has a verified solution.

If you are experiencing a similar issue, please ask a related question

User art_snob (http://www.experts-exchange.com/M_6114203.html) encountered strange behavior of Android Web browser on his Mobile Web site. It took a while to find the true cause. It happens so, that the Android Web browser (at least up to OS ver. 2.…
This article shows how to deploy dynamic backgrounds to computers depending on the aspect ratio of display
This Micro Tutorial will give you a basic overview how to record your screen with Microsoft Expression Encoder. This program is still free and open for the public to download. This will be demonstrated using Microsoft Expression Encoder 4.
A short tutorial showing how to set up an email signature in Outlook on the Web (previously known as OWA). For free email signatures designs, visit https://www.mail-signatures.com/articles/signature-templates/?sts=6651 If you want to manage em…

776 members asked questions and received personalized solutions in the past 7 days.

Join the community of 500,000 technology professionals and ask your questions.

Join & Ask a Question