Re: code documentation reports

Check out http://www.codeproject.com/useritems/SandcastleBuilder.asp
.... It helps a lot :)

Sébastien

On 10/6/06, Peter Osucha <[email protected]> wrote:
> I did notice, Shawn, (with a little dismay) that getting this to work with
> all the scripts (or batch files) is certainly not trivial.  The notes I saw
> suggested that a GUI was coming sometime for the product but who knows how
> far away that is.
>
> I looked over nDoc as well but it seemed to be written more for VS2003 (or
> Net 1.1) - notes I saw suggested problems with Net 2.0 code - particularly
> generics.
>
> Peter
>
>
> > -----Original Message-----
> > From: Discussion relating to the specifics of the C# and
> > Managed C++ languages [mailto:[email protected]]
> > On Behalf Of Shawn Wildermuth
> > Sent: Thursday, October 05, 2006 9:10 PM
> > To: [email protected]
> > Subject: Re: [DOTNET-CX] code documentation reports
> >
> > FYI, this does work but it still has some bugs and absolutely
> > no easy solution (unlike nDoc) to create them.  You end up
> > writing long batch scripts to do it.  It does work though as
> > I recently did it for one of my projects, but expect to spend
> > a 1/2 day getting all the pieces and writing the scripts.
> >
> >
> > Thanks,
> >
> > Shawn Wildermuth
> > Wildermuth Consulting Services, LLC
> > http://adoguy.com
> > C# MVP, MCSD.NET, Author and Speaker
> >
> >
> > > -----Original Message-----
> > > From: Discussion relating to the specifics of the C# and
> > Managed C++
> > > languages [mailto:[email protected]]
> > > On Behalf Of Jeff Fedor
> > > Sent: Thursday, October 05, 2006 12:09 PM
> > > To: [email protected]
> > > Subject: Re: [DOTNET-CX] code documentation reports
> > >
> > > Checkout Sandcastle
> > >
> > > http://www.microsoft.com/downloads/details.aspx?FamilyID=e82ea
> > 71d-da89-4
> > > 2ee-a715-696e3a4873b2&DisplayLang=en
> > >
> > > j
> > >
> > > -----Original Message-----
> > > From: Discussion relating to the specifics of the C# and
> > Managed C++
> > > languages [mailto:[email protected]]
> > > On Behalf Of Peter Osucha
> > > Sent: Thursday, October 05, 2006 11:55 AM
> > > To: [email protected]
> > > Subject: [DOTNET-CX] code documentation reports
> > >
> > > I have several C# projects for which I have generated XML code
> > > documentation.  So I finally am getting around to trying to
> > use these
> > > xml files.  After a bit of searching, I discovered something called
> > > NDoc (apparently written for Net
> > > 1.1) to help turn such XML files into 'help'
> > > files.  I haven't found much else though.
> > >
> > > For those who choose to document source code so as to
> > produce such XML
> > > files, what do you use to 'go to the next step'
> > > (create help files or other more readable documentation from them)?
> > >
> > > Peter
>
> ===================================
> This list is hosted by DevelopMentor(r)  http://www.develop.com
>
> View archives and manage your subscription(s) at http://discuss.develop.com
>

===================================
This list is hosted by DevelopMentor®  http://www.develop.com

View archives and manage your subscription(s) at http://discuss.develop.com