Discription of every parameter

Question

0.00/5 (No votes)

See more:

Hi,
i want to create a methood and for every parameter want to show discription that how the parameter should be
eg

VB

Public Sub Print_TITEM(ByVal Status As String, ByVal Type As String)
    sb.AppendLine("TITEM" & Lcount(LineCount) & Status & Type)
    LineCount += 1

End Sub

like this many methoods are there and many after me going 2 use this class
so i need to show how the parameter should be with space without space etc..
like how visual studio shows for standard functions

Posted 3-Sep-13 3:18am

Basmeh Awad

Updated 3-Sep-13 3:28am

v3

Add a Solution

1 solution

Add a Solution

Add your solution here

Treat my content as plain text, not as HTML

Preview 0

…

Existing Members

Sign in to your account

...or Join us

Download, Vote, Comment, Publish.

Your Email
Password
Forgot your password?

Your Email
This email is in use. Do you need your password?
Optional Password

I have read and agree to the Terms of Service and Privacy Policy
Please subscribe me to the CodeProject newsletters

When answering a question please:

Read the question carefully.
Understand that English isn't everyone's first language so be lenient of bad spelling and grammar.
If a question is poorly phrased then either ask for clarification, ignore it, or edit the question and fix the problem. Insults are not welcome.
Don't tell someone to read the manual. Chances are they have and don't get it. Provide an answer or move on to the next question.

Let's work to help developers, not make them feel stupid.

This content, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

OriginalGriff · Accepted Answer · 2013-09-03T03:34:00

It's called "XML Documentation", and you can read about it here: http://msdn.microsoft.com/en-us/library/ms172652.aspx[^]

Set "Generate XML documentation file" in Project menu, click Properties, Compile page.
Then type ''' before your method.

VB

''' <summary>
''' Your method description here
''' </summary>
''' <param name="Status">Describe what the parameter does here</param>
''' <param name="Type">Describe what the parameter does here</param>
Public Sub Print_TITEM(Status As String, Type As String)
    sb.AppendLine("TITEM" & Lcount(LineCount) & Status & Type)
    LineCount += 1
End Sub