Help with documentation in Csharp

What do you prefer for VS2005 and
.Net 2?

VSdocman. But I'm strongly biased :)

Peter Macej
Helixoft - http://www.helixoft.com
VSdocman - Commenter and generator of class documentation for C#, VB
.NET and ASP .NET code

MS has an initiative that looks promissing:

http://www.sandcastledocs.com/Wiki%.../Home.aspx

Patrik Löwendahl [C# MVP]
http://www.lowendahl.net

"JC" wrote in message
news:

I like your opinions about the best way of documenting the code in Csharp.

To my particularly I like the solution given in VST 2000 but that they
(Microsoft) removed of 2005.

That you think about Ndoc and others? What do you prefer for VS2005 and
.Net 2?

Thanks...

I have used NDoc for many years but the lack of support for later
iterations of the framework has killed it for me.

Sandcastle is the only way to go as far as I can see. It's rough and
ready at the moment but sources within MS keep saying it's going to be
integrated into the system so get started with the betas, albeit a
little painfully, and keep the faith.

Bob Powell [MVP]
Visual C#, System.Drawing

Ramuseco Limited .NET consulting
http://www.ramuseco.com

Find great Windows Forms articles in Windows Forms Tips and Tricks
http://www.bobpowell.net/tipstricks.htm

Answer those GDI+ questions with the GDI+ FAQ
http://www.bobpowell.net/faqmain.htm

All new articles provide code in C# and VB.NET.
Subscribe to the RSS feeds provided and never miss a new article.





JC wrote:

I like your opinions about the best way of documenting the code in Csharp.

To my particularly I like the solution given in VST 2000 but that they
(Microsoft) removed of 2005.

That you think about Ndoc and others? What do you prefer for VS2005 and
.Net 2?

Thanks...

Hi,

Patrik Löwendahl wrote:

MS has an initiative that looks promissing:

http://www.sandcastledocs.com/Wiki%.../Home.aspx

I vote for Sandcastle too. And of course the necessary companion:
http://www.codeplex.com/Wiki/View.a...tName=SHFB

HTH,
Laurent
Laurent Bugnion [MVP ASP.NET]
Software engineering: http://www.galasoft-LB.ch
PhotoAlbum: http://www.galasoft-LB.ch/pictures
Support children in Calcutta: http://www.calcutta-espoir.ch

I have been doing my own XSL transforms for a couple of years now, with good
results. But Sandcastle looks like an excellent solution that provides a
more standardized output.

HTH,

Kevin Spencer
Microsoft MVP
Bit Player
http://unclechutney.blogspot.com

Where there's a Will, there's a William.

"Bob Powell [MVP]" wrote in message
news:e4sGB%

I have used NDoc for many years but the lack of support for later
iterations of the framework has killed it for me.

Sandcastle is the only way to go as far as I can see. It's rough and ready
at the moment but sources within MS keep saying it's going to be
integrated into the system so get started with the betas, albeit a little
painfully, and keep the faith.

Bob Powell [MVP]
Visual C#, System.Drawing

Ramuseco Limited .NET consulting
http://www.ramuseco.com

Find great Windows Forms articles in Windows Forms Tips and Tricks
http://www.bobpowell.net/tipstricks.htm

Answer those GDI+ questions with the GDI+ FAQ
http://www.bobpowell.net/faqmain.htm

All new articles provide code in C# and VB.NET.
Subscribe to the RSS feeds provided and never miss a new article.





JC wrote:

I like your opinions about the best way of documenting the code in
Csharp.

To my particularly I like the solution given in VST 2000 but that they
(Microsoft) removed of 2005.

That you think about Ndoc and others? What do you prefer for VS2005 and
.Net 2?

Thanks...