473,394 Members | 1,773 Online
Bytes | Software Development & Data Engineering Community
Post Job

Home Posts Topics Members FAQ

Join Bytes to post your question to a community of 473,394 software developers and data experts.

Help with documentation in Csharp

JC
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...

Dec 29 '06 #1
6 1390
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
Dec 29 '06 #2
MS has an initiative that looks promissing:

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

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

"JC" <jc***@macomexpress.comwrote in message
news:OQ**************@TK2MSFTNGP06.phx.gbl...
>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...
Dec 29 '06 #3
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...
Dec 30 '06 #4
Hi,

Patrik Löwendahl wrote:
MS has an initiative that looks promissing:

http://www.sandcastledocs.com/Wiki%20Pages/Home.aspx
I vote for Sandcastle too. And of course the necessary companion:
http://www.codeplex.com/Wiki/View.aspx?ProjectName=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
Jan 1 '07 #5
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]" <bob@_spamkiller_bobpowell.netwrote in message
news:e4***************@TK2MSFTNGP02.phx.gbl...
>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...

Jan 2 '07 #6
Seguís siendo tan pelotudo como siempre escribiendo en ingles en un
newsgroup en castellano? Madurá un poquito, boludo.
JC escribió:
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...
Jan 2 '07 #7

This thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

14
by: Jim Hubbard | last post by:
I am looking for documentation and code examples on DDML (Display Driver Management Level). It is mentioned in the 2000, XP and 2003 DDKs - but just barely. It has to do with mirroring a...
7
by: Timothy Shih | last post by:
Hi, I am trying to figure out how to use unmanaged code using P/Invoke. I wrote a simple function which takes in 2 buffers (one a byte buffer, one a char buffer) and copies the contents of the byte...
1
by: maddog | last post by:
sorry, I don't know if is this the right group. I build a class-lib in csharp, and there comments are well xml formed.(///) I have another project use the class-lib(a dll file) I builed...
23
by: Jason | last post by:
Hi, I was wondering if any could point me to an example or give me ideas on how to dynamically create a form based on a database table? So, I would have a table designed to tell my application...
5
by: Manuel Lopez | last post by:
Here's a simple question: how do I download or print out the entire documentation (or a large chunk) in readable format (doc or pdf)? It's not of much use to me if I have to go to every separate...
4
by: gs | last post by:
I have searched Google, MSDN,... for a week. I am still unable to make available functions in my csharp dll as native windows functions for some legacy non dotnet application I just want to...
0
by: Ben Crinion | last post by:
Hi Im using ASP.NET 2 with C# in codebehind files and Visual Studio 2005 Team Edition. I have embedded lots of XML Documentation (<summary>,<see>,etc) into my ASP.NET project in code behind...
10
by: gzinger | last post by:
Since I never seen the following question answered, I am re-posting it: Hi Im using ASP.NET 2 with C# in codebehind files and Visual Studio 2005 Team Edition. I have embedded lots of XML...
2
by: Tim_Mac | last post by:
hi, i have VS2005 professional, and i would like to generate a complete documentation reference for all the classes in my web project. i would have thought this was as simple as a button or build...
0
by: ryjfgjl | last post by:
If we have dozens or hundreds of excel to import into the database, if we use the excel import function provided by database editors such as navicat, it will be extremely tedious and time-consuming...
0
by: ryjfgjl | last post by:
In our work, we often receive Excel tables with data in the same format. If we want to analyze these data, it can be difficult to analyze them because the data is spread across multiple Excel files...
0
by: emmanuelkatto | last post by:
Hi All, I am Emmanuel katto from Uganda. I want to ask what challenges you've faced while migrating a website to cloud. Please let me know. Thanks! Emmanuel
0
BarryA
by: BarryA | last post by:
What are the essential steps and strategies outlined in the Data Structures and Algorithms (DSA) roadmap for aspiring data scientists? How can individuals effectively utilize this roadmap to progress...
1
by: nemocccc | last post by:
hello, everyone, I want to develop a software for my android phone for daily needs, any suggestions?
0
marktang
by: marktang | last post by:
ONU (Optical Network Unit) is one of the key components for providing high-speed Internet services. Its primary function is to act as an endpoint device located at the user's premises. However,...
0
jinu1996
by: jinu1996 | last post by:
In today's digital age, having a compelling online presence is paramount for businesses aiming to thrive in a competitive landscape. At the heart of this digital strategy lies an intricately woven...
0
by: Hystou | last post by:
Overview: Windows 11 and 10 have less user interface control over operating system update behaviour than previous versions of Windows. In Windows 11 and 10, there is no way to turn off the Windows...
0
tracyyun
by: tracyyun | last post by:
Dear forum friends, With the development of smart home technology, a variety of wireless communication protocols have appeared on the market, such as Zigbee, Z-Wave, Wi-Fi, Bluetooth, etc. Each...

By using Bytes.com and it's services, you agree to our Privacy Policy and Terms of Use.

To disable or enable advertisements and analytics tracking please visit the manage ads & tracking page.