Solved

Adding guidance into classes for end users

Posted on 2014-09-18
2
205 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
[X]
Welcome to Experts Exchange

Add your voice to the tech community where 5M+ people just like you are talking about what matters.

  • Help others & share knowledge
  • Earn cash & points
  • Learn & ask questions
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

Secure Your Active Directory - April 20, 2017

Active Directory plays a critical role in your company’s IT infrastructure and keeping it secure in today’s hacker-infested world is a must.
Microsoft published 300+ pages of guidance, but who has the time, money, and resources to implement? Register now to find an easier way.

Question has a verified solution.

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

Calculating holidays and working days is a function that is often needed yet it is not one found within the Framework. This article presents one approach to building a working-day calculator for use in .NET.
Real-time is more about the business, not the technology. In day-to-day life, to make real-time decisions like buying or investing, business needs the latest information(e.g. Gold Rate/Stock Rate). Unlike traditional days, you need not wait for a fe…

735 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