Documentation of C# projects

Question

1.00/5 (2 votes)

See more:

We need to create documentation for the entire project.
Can you see, if you can locate a good tool we can use?
first we'll find a tool that generate documentation from a project and include all code commenting, then we need to document each single variable and function?

Posted 7-Nov-13 23:54pm

sunandandutt

Updated 8-Nov-13 0:25am

Richard MacCutchan

v4

Add a Solution

Comments

Richard MacCutchan 8-Nov-13 6:25am

There are lots of tools around, and Google will find them for you.

sunandandutt 8-Nov-13 6:27am

can you please explain any two tools?

Richard MacCutchan 8-Nov-13 6:34am

Explain any two what?

2 solutions

Add a Solution

Add your solution here

Treat my content as plain text, not as HTML

Preview 0

…

Existing Members

Sign in to your account

...or Join us

Download, Vote, Comment, Publish.

Your Email
Password
Forgot your password?

Your Email
This email is in use. Do you need your password?
Optional Password

I have read and agree to the Terms of Service and Privacy Policy
Please subscribe me to the CodeProject newsletters

When answering a question please:

Read the question carefully.
Understand that English isn't everyone's first language so be lenient of bad spelling and grammar.
If a question is poorly phrased then either ask for clarification, ignore it, or edit the question and fix the problem. Insults are not welcome.
Don't tell someone to read the manual. Chances are they have and don't get it. Provide an answer or move on to the next question.

Let's work to help developers, not make them feel stupid.

This content, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

johannesnestler · Answer 1 · 2013-11-08T00:35:00

Solution 1

I use http://sandcastle.codeplex.com/[^]

Posted 8-Nov-13 0:35am

johannesnestler

Comments

Andreas Gieriet 8-Nov-13 7:20am

In daily use, but producing documentation is extremly slow for larger projects.
Cheers
Andi

johannesnestler 8-Nov-13 7:29am

:-) right - better not to always rebuild it with CI builds...

lukeer · Answer 2 · 2013-11-08T00:41:00

Solution 2

I recommend doxygen[^].

Posted 8-Nov-13 0:41am

lukeer

Comments

johannesnestler 8-Nov-13 6:53am

I think sandcastle has better experience for .net (it installs a project template for VS - so better sourcecontrol integration etc.) - used doxygen back in the "old" C++ days so maybe my knowledge about it is a little "outdated".

Andreas Gieriet 8-Nov-13 7:20am

Same for me (as johannesnestler): I use it in C++ but not yet in C#. Don't know how well doxygen integrates with other .Net tools. Maybe you can comment on this from your experience?
Cheers
Andi

lukeer 8-Nov-13 7:43am

I rarely use any .NET tools except from Visual Studio.
Just Tortoise SVN and doxygen, both doing their work without being integrated in any form I'm aware of.