Exporting Summaries written for functions

  • Thread starter Thread starter amir.khatibzadeh
  • Start date Start date
A

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

/// <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?
 
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?

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.
 

Ask a Question

Want to reply to this thread or ask your own question?

You'll need to choose a username for the site, which only take a couple of moments. After that, you can post your question and our members will help you out.

Ask a Question

Back
Top