Groups | Blog | Home
all groups > dotnet faqs > january 2008 >

dotnet faqs : Exporting Summaries written for functions


amir.khatibzadeh@gmail.com
1/16/2008 2:48:02 AM
hi every body, i want to know how could it be possible to export
information and summaries I wrote for a function!

to clear up my Q

this is my summaries written for function

/// <summary>
/// get the column name of a column field of a table
/// </summary>
/// <param name="ColField"> Column Field </param>
/// <returns>the column name of the column field </returns>
private string GetColumnName(string ColField)
{
string p;
// do something
return p;
}

there is a way that i could export the summaries as a html file for
documentary

is there anybody know how to do it?
Mattias Sjögren
1/16/2008 9:21:26 PM
[quoted text, click to view]

The compiler can extract the comments to an XML file if you supply the
right compiler option (/doc on the command line).

To produce proper documentation from the XML file you can use an XSL
transform (may suffice if all you need is simple HTML) or a tool like
Sandcastle or NDOC.

http://www.codeplex.com/Sandcastle/
http://ndoc.sourceforge.net/


Mattias

--
Mattias Sjögren [C# MVP] mattias @ mvps.org
http://www.msjogren.net/dotnet/ | http://www.dotnetinterop.com
AddThis Social Bookmark Button