Exporting Summaries written for functions

Exporting Summaries written for functions

am 16.01.2008 12:12:33 von amir.khatibzadeh

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

///


/// get the column name of a column field of a table
///
/// Column Field
/// the column name of the column field
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?

Re: Exporting Summaries written for functions

am 16.01.2008 15:01:57 von lasse

amir.khatibzadeh@gmail.com wrote:
> 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
>
> ///


> /// get the column name of a column field of a table
> ///
> /// Column Field
> /// the column name of the column field
> 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?

In the project settings you need to enable xml documentation production,
you'll find this on the build tab.

This produces an xml file, and with tools like Sandcastle, you can
produce help files for your class library.

The Sandcastle help file builder can be found here:
http://www.codeplex.com/SHFB

Follow links further down on that page for the other tools you need.

--
Lasse Vågsæther Karlsen
mailto:lasse@vkarlsen.no
http://presentationmode.blogspot.com/
PGP KeyID: 0xBCDEA2E3