Ureader.com  
Microsoft software help and Community
   home   |   control panel login   |   archive   |  
 
DotNet
acad.assignment.mngr
academic
adonet
aspnet
aspnet.announcements
aspnet.build.controls
aspnet.caching
aspnet.datagridcontrol
aspnet.mobile
aspnet.security
aspnet.webcontrols
aspnet.webservices
clr
compactframework
component_services
datatools
distributed_apps
drawing
faqs
framework
framework.wmi
general
internationalization
interop
languages.csharp
languages.jscript
languages.vb
languages.vb.controls
languages.vb.data
languages.vb.upgrade
languages.vc
languages.vc.libraries
myservices
odbcnet
performance
remoting
scripting
sdk
security
setup
vjsharp
vsa
webservi.enhancements
webservices
windowsforms
windowsforms.controls
winforms.databinding
winforms.designtime
xml
  
 
date: Wed, 16 Jan 2008 02:48:02 -0800 (PST),    group: microsoft.public.dotnet.faqs        back       


Exporting Summaries written for functions   
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?
date: Wed, 16 Jan 2008 02:48:02 -0800 (PST)   author:   unknown

Re: Exporting Summaries written for functions   
>there is a way that i could export the summaries as a html file for
>documentary

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
Please reply only to the newsgroup.
date: Wed, 16 Jan 2008 21:21:26 +0100   author:   Mattias Sj?gren

Google
 
Web ureader.com


    COPYRIGHT 2007, YARDI TECHNOLOGY LIMITED, ALL RIGHT RESERVE  |   contact us