PC Review


Reply
Thread Tools Rate Thread

App Help and Documentation Tools

 
 
Felipe T.
Guest
Posts: n/a
 
      16th Mar 2004
Hi,
Im wondering what are the tools available for
generating .chm, help and documentation of a .Net project?

Thx,
Felipe


 
Reply With Quote
 
 
 
 
Peter Foot [MVP]
Guest
Posts: n/a
 
      16th Mar 2004
NDoc is a very flexible tool for generating documentation in either CHM or
HTML Help 2.0 format (for integration with the Visual Studio collection). I
wrote an article on this a while back
(http://www.opennetcf.org/PermaLink.a...72-bdb2-fe6343
284dca), we use NDoc with all our libraries - you can see the results here
www.opennetcf.org/library/



Peter

--
Peter Foot
Windows Embedded MVP
OpenNETCF.org Senior Advisor
www.inthehand.com | www.opennetcf.org

"Felipe T." <(E-Mail Removed)> wrote in message
news:(E-Mail Removed)...
> Hi,
> Im wondering what are the tools available for
> generating .chm, help and documentation of a .Net project?
>
> Thx,
> Felipe
>
>



 
Reply With Quote
 
Felipe T.
Guest
Posts: n/a
 
      16th Mar 2004
Thx Peter,

Iv tryed NDoc, it works perfectly for DLLs. But i cant get it working on
EXEs.
Anyway, ill keep on trying some other tools.



"Peter Foot [MVP]" <(E-Mail Removed)> wrote in message
news:(E-Mail Removed)...
> NDoc is a very flexible tool for generating documentation in either CHM or
> HTML Help 2.0 format (for integration with the Visual Studio collection).

I
> wrote an article on this a while back
>

(http://www.opennetcf.org/PermaLink.a...72-bdb2-fe6343
> 284dca), we use NDoc with all our libraries - you can see the results here
> www.opennetcf.org/library/
>
>
>
> Peter
>
> --
> Peter Foot
> Windows Embedded MVP
> OpenNETCF.org Senior Advisor
> www.inthehand.com | www.opennetcf.org
>
> "Felipe T." <(E-Mail Removed)> wrote in message
> news:(E-Mail Removed)...
> > Hi,
> > Im wondering what are the tools available for
> > generating .chm, help and documentation of a .Net project?
> >
> > Thx,
> > Felipe
> >
> >

>
>



 
Reply With Quote
 
Peter Foot [MVP]
Guest
Posts: n/a
 
      16th Mar 2004
There are a few gotchas regarding NDoc on Compact Framework code when you
use code that is specific to the Compact Framework Microsoft.WindowsCE.*
for example and also when inheriting classes where there are naming
conflicts between methods/properties you add and those available only on the
full desktop framework - this is because NDoc reflects your classes from the
full framework, this is a problem when inheriting from CommonDialog and
other classes which are significantly slimmed down on the Compact Framework.
The only workaround is to use conditional compilation and hide sections of
your source code from NDoc by building a documentation specific version of
the app or dll.

Peter

--
Peter Foot
Windows Embedded MVP
OpenNETCF.org Senior Advisor
www.inthehand.com | www.opennetcf.org

"Felipe T." <(E-Mail Removed)> wrote in message
news:(E-Mail Removed)...
> Thx Peter,
>
> Iv tryed NDoc, it works perfectly for DLLs. But i cant get it working on
> EXEs.
> Anyway, ill keep on trying some other tools.
>
>
>
> "Peter Foot [MVP]" <(E-Mail Removed)> wrote in message
> news:(E-Mail Removed)...
> > NDoc is a very flexible tool for generating documentation in either CHM

or
> > HTML Help 2.0 format (for integration with the Visual Studio

collection).
> I
> > wrote an article on this a while back
> >

>

(http://www.opennetcf.org/PermaLink.a...72-bdb2-fe6343
> > 284dca), we use NDoc with all our libraries - you can see the results

here
> > www.opennetcf.org/library/
> >
> >
> >
> > Peter
> >
> > --
> > Peter Foot
> > Windows Embedded MVP
> > OpenNETCF.org Senior Advisor
> > www.inthehand.com | www.opennetcf.org
> >
> > "Felipe T." <(E-Mail Removed)> wrote in message
> > news:(E-Mail Removed)...
> > > Hi,
> > > Im wondering what are the tools available for
> > > generating .chm, help and documentation of a .Net project?
> > >
> > > Thx,
> > > Felipe
> > >
> > >

> >
> >

>
>



 
Reply With Quote
 
Felipe T.
Guest
Posts: n/a
 
      16th Mar 2004
Thx!

"Peter Foot [MVP]" <(E-Mail Removed)> wrote in message
news:(E-Mail Removed)...
> There are a few gotchas regarding NDoc on Compact Framework code when you
> use code that is specific to the Compact Framework Microsoft.WindowsCE.*
> for example and also when inheriting classes where there are naming
> conflicts between methods/properties you add and those available only on

the
> full desktop framework - this is because NDoc reflects your classes from

the
> full framework, this is a problem when inheriting from CommonDialog and
> other classes which are significantly slimmed down on the Compact

Framework.
> The only workaround is to use conditional compilation and hide sections of
> your source code from NDoc by building a documentation specific version of
> the app or dll.
>
> Peter
>
> --
> Peter Foot
> Windows Embedded MVP
> OpenNETCF.org Senior Advisor
> www.inthehand.com | www.opennetcf.org
>
> "Felipe T." <(E-Mail Removed)> wrote in message
> news:(E-Mail Removed)...
> > Thx Peter,
> >
> > Iv tryed NDoc, it works perfectly for DLLs. But i cant get it working on
> > EXEs.
> > Anyway, ill keep on trying some other tools.
> >
> >
> >
> > "Peter Foot [MVP]" <(E-Mail Removed)> wrote in message
> > news:(E-Mail Removed)...
> > > NDoc is a very flexible tool for generating documentation in either

CHM
> or
> > > HTML Help 2.0 format (for integration with the Visual Studio

> collection).
> > I
> > > wrote an article on this a while back
> > >

> >

>

(http://www.opennetcf.org/PermaLink.a...72-bdb2-fe6343
> > > 284dca), we use NDoc with all our libraries - you can see the results

> here
> > > www.opennetcf.org/library/
> > >
> > >
> > >
> > > Peter
> > >
> > > --
> > > Peter Foot
> > > Windows Embedded MVP
> > > OpenNETCF.org Senior Advisor
> > > www.inthehand.com | www.opennetcf.org
> > >
> > > "Felipe T." <(E-Mail Removed)> wrote in message
> > > news:(E-Mail Removed)...
> > > > Hi,
> > > > Im wondering what are the tools available for
> > > > generating .chm, help and documentation of a .Net project?
> > > >
> > > > Thx,
> > > > Felipe
> > > >
> > > >
> > >
> > >

> >
> >

>
>



 
Reply With Quote
 
 
 
Reply

Thread Tools
Rate This Thread
Rate This Thread:

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is On
HTML code is Off
Trackbacks are On
Pingbacks are On
Refbacks are Off


Similar Threads
Thread Thread Starter Forum Replies Last Post
Documentation tools Raymond via DotNetMonster.com Microsoft ASP .NET 0 6th Apr 2006 01:26 AM
Documentation Tools AWHK Microsoft Dot NET 3 9th Nov 2005 06:05 AM
Documentation Tools Brad Markisohn Microsoft VB .NET 2 4th Jan 2005 04:32 PM
Best Documentation & Flowcharting Tools ASP.NET =?Utf-8?B?TiBTIFM=?= Microsoft ASP .NET 0 19th Nov 2004 05:29 PM
MS Access / Tools / Analyis / Documentation John Bruen Microsoft Access 2 16th Jan 2004 05:59 PM


Features
 

Advertising
 

Newsgroups
 


All times are GMT +1. The time now is 03:01 PM.