Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

how to write description for method [duplicate]

Possible Duplicate:
XML multiline comments in C# - what am I doing wrong?
Multiline XML Comments in VB.Net and Visual Studio Intellisense

I want to have some description for my method

/// <summary> 
/// Perform a divide by b
///      e.g a = 1, b = 2
/// will return 0, since (1/2) = 0.5
/// </summary>
/// <returns>int value</returns>
public static int Div(int a, int b)
{


    return (a / b);
}

and i want the description show in the same format that i type.. however, those text will always display in oneline.

is there any tag that i can use to ask visual studio to include all those space and new line?

Thanks

like image 255
jojo Avatar asked Jan 20 '12 03:01

jojo


1 Answers

I believe putting your lines in <para /> tags works.

///<summary>
///<para>line1</para>
///<para>line2</para>
///</summary>
like image 56
itsme86 Avatar answered Oct 25 '22 09:10

itsme86