adding XML documentation to dll in C#

  • Thread starter Thread starter teenagarg
  • Start date Start date
T

teenagarg

Hi,
I want to add description of my functions in C#. I have there dll.
This is for sure that I had to add XML documentation.
But I don't know how to begin. I am new to C#.
Help me by giving some example.

Thanks in advance
Teena
 
Hi,
If you want to add description of your functions, you can follow this method; at the beginning of your methods
Click to expand...
you enter three slash (///) , after this you can see description outline appear..for example

/// <summary>
/// Initializes a new instance of the Matrix class
/// </summary>
/// <param name="row">Number of rows</param>
 
You might want to get yourself a copy of Roland Weigelt's "GhostDoc"
add - in, and a Copy of NDoc.

These 2 tools, plus the HTMLHelpWorkshop help compiler, make creating
professsional MSDN-style help a breeze.
 
Hi Marie,
Thanks for reply. I have done exactly same as told by you. I added
summary of all the functions in my sources and then created its dll to
add in the project. But the description of functions is not coming after
placing dot to class object in .NET IDE. Where I am doing wrong...

Thanks
Teena


method; at the beginning of your methods
you enter three slash (///) , after this you can see description outline appear..for example

/// <summary>
/// Initializes a new instance of the Matrix class
/// </summary>
/// <param name="row">Number of rows</param>
Click to expand...
attributes come into view.For example ;"return", "exception",
"remarks"...
 
Back
Top